Queries the information about the servers whose Security Center agent status is Offline.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-sas:DescribeOfflineMachines | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SourceIp | string | No | The source IP address of the request. | 180.113.XX.XX |
| PageSize | integer | No | The number of entries to return on each page. Default value: 5. | 5 |
| CurrentPage | integer | No | The number of the page to return. Default value: 1. | 4 |
| RegionNo | string | No | The region in which the server resides. Note
The value of this parameter is the value of the Values parameter that is returned by calling the DescribeCriteria operation. If the value of the Name parameter in the response is regionId, the value of the Values parameter indicates a region ID.
| cn-hangzhou |
| Os | string | No | The operating system of the server. Note
The value of this parameter is the value of the Values parameter that is returned by calling the DescribeCriteria operation. If the value of the Name parameter in the response is osType, the value of the Values parameter indicates an operating system.
| linux |
| Remark | string | No | The information about the server that you want to query. The value can be the name or the public IP address of the server. | 172.20.XX.XX |
| Vendor | integer | No | The source of the server. Valid values:
| 0 |
| RegionIdStr | string | No | The region in which the server resides. Note
The value of this parameter is the value of the Values parameter that is returned by calling the DescribeCriteria operation. If the value of the Name parameter in the response is regionId, the value of the Values parameter indicates a region ID.
| cn-hangzhou |
Response parameters
Examples
Sample success responses
JSONformat
{
"CurrentPage": 1,
"RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
"PageSize": 5,
"TotalCount": 44,
"MachineList": [
{
"Uuid": "6d5b361f-958d-48a8-a9d2-d6e82c1****",
"MachineRegion": "cn-hangzhou",
"InternetIp": "120.79.XX.XX",
"VendorName": "ALIYUN",
"InstanceName": "sql-test-001",
"Os": "linux",
"InstanceId": "sas-bdrvxb4b****",
"IntranetIp": "192.168.XX.XX",
"Vendor": 0,
"RegionId": "cn-shanghai"
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | NoPermission | caller has no permission | You are not authorized to do this operation. |
| 500 | ServerError | ServerError | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2022-12-23 | API Description Update. The API operation is not deprecated. | View Change Details |