Domain name for API request: cwp.tencentcloudapi.com.
This API is used to obtain the visualized list of host regions on the large screen.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeScreenMachines. |
Version | Yes | String | Common Params. The value used for this API: 2018-02-28. |
Region | No | String | Common Params. This parameter is not required. |
MachineRegion | No | String | Host region |
MachineIpOrAlias | No | String | Private IP address or host alias |
SecurityStatus | No | Integer | Risky host type. 0: all types; 1: risky host; 2: host with potential risks; 3: host that is shut down or offline; 4: host with no risk. |
Parameter Name | Type | Description |
---|---|---|
List | Array of ScreenRegionMachines | List details Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://cwp.tencentcloudapi.com/?Action=DescribeScreenMachines
&<Common request parameters>
{
"Response": {
"List": [
{
"TotalCount": 1,
"Region": "xx",
"Machines": [
{
"InvasionNum": 0,
"MachineOs": "xx",
"Uuid": "xx",
"CpuSize": 0.0,
"MemLoad": "xx",
"MachineName": "xx",
"DiskLoad": "xx",
"BaselineNum": 0,
"MachineIp": "xx",
"CpuLoad": "xx",
"CyberAttackNum": 0,
"DiskSize": 0.0,
"Quuid": "xx",
"SecurityStatus": "xx",
"MemSize": 0.0,
"MachineStatus": "xx",
"MachineWanIp": "xx",
"MachineType": "xx",
"VulNum": 0
}
],
"RegionName": "xx"
}
],
"RequestId": "0e078e5e-32bf-41ba-853c-88c697888d99"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error |
InternalError.MainDBFail | Failed to manipulate the data. |
InvalidParameter | Incorrect parameter. |
ResourceNotFound | The resource does not exist. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?