Queries the information about assets that meet specific search conditions. For example, you can search for assets by the instance name or region of the asset.
Operation description
You can search for an asset by using search conditions, such as the instance ID, instance name, virtual private cloud (VPC) ID, region, and public IP address. You can also configure a logical relationship between multiple search conditions to search for the assets that meet the search conditions.
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:DescribeCloudCenterInstances | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
RegionIddeprecated | string | No | The ID of the region in which the asset resides. | cn-hangzhou |
| Criteria | string | No | The search conditions. The value of this parameter is in the JSON format and is case-sensitive. Note
You can search for an asset by using the search conditions, such as the instance ID, instance name, VPC ID, region, or public IP address. You can call the DescribeCriteria operation to query the supported search conditions.
| [{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}] |
| MachineTypes | string | No | The type of the assets that you want to query. Valid values:
| ecs |
| LogicalExp | string | No | The logical relationship among multiple search conditions. Valid values:
| OR |
| PageSize | integer | No | The number of entries to return on each page. Default value: 20. | 100 |
| CurrentPage | integer | No | The number of the page to return. Default value: 1. | 1 |
| Importance | integer | No | The importance of the asset. Valid values:
| 2 |
| NoGroupTrace | boolean | No | Specifies whether to internationalize the name of the default group. Valid values:
| false |
| Lang | string | No | The language of the content within the request and response. Default value: zh. Valid values:
| zh |
| UseNextToken | boolean | No | Specifies whether to use the NextToken method to retrieve a new page of results. If you set UseNextToken to true, the value of TotalCount is not returned. Valid values:
| false |
| NextToken | string | No | The value of NextToken that is returned when the NextToken method is used. You do not need to specify this parameter for the first request. | E17B501887A2D3AA5E8360A6EFA3B*** |
| ResourceDirectoryAccountId | long | No | The Alibaba Cloud account ID of the member in the resource directory. Note
You can call the DescribeMonitorAccounts operation to obtain the IDs.
| 1232428423234**** |
| Flags | string | No | The service provider of the asset. Separate multiple service providers with commas (,). Valid values:
| 1,2,3 |
Response parameters
Examples
Sample success responses
JSONformat
{
"Success": true,
"RequestId": "32A73759-4C0F-4801-BE98-901223ACEE9A",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 50,
"Count": 10,
"NextToken": "B604532DEF982B875E8360A6EFA3B***"
},
"Instances": [
{
"Status": "Running",
"CpuInfo": "Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz",
"InternetIp": "1.2.XX.XX",
"Kernel": "3.10.0-1127.19.1.el7.x86_64",
"Bind": true,
"OsName": "-",
"Tag": "InternetIp,test",
"ClientStatus": "online",
"Mem": 1024,
"VpcInstanceId": "vpc-uf60agqq65bs98zoo****",
"TagId": "121313,41412",
"Flag": 0,
"LastLoginTimestamp": 1637592907000,
"AuthVersion": 3,
"Region": "cn-hangzhou-cm***-***",
"InstanceName": "yztest-l***",
"PodCount": 1,
"VulCount": 2,
"HcStatus": "YES",
"CreatedTime": 1607365213000,
"GroupTrace": "default",
"ClusterId": "c690a0789419f4284a4e0a29e12fe****",
"RiskStatus": "NO",
"Cores": 4,
"VulStatus": "YES",
"AlarmStatus": "NO",
"MacListString": "00:13:3e:31:13:39,02:12:67:b8:**:**",
"Importance": 2,
"HealthCheckCount": 1,
"Ip": "1.2.XX.XX",
"Os": "Linux",
"AuthModifyTime": 1627974044000,
"SafeEventCount": 5,
"InstanceId": "i-m5***",
"AssetType": "ecs",
"IntranetIp": "1.2.XX.XX",
"Vendor": 0,
"RegionId": "cn-hanghzou",
"Uuid": "c9107c04-942f-40c1-981a-f1c1***",
"GroupId": 4120080,
"RegionName": "China (Hangzhou)",
"VendorName": "Tencent",
"AuthVersionName": "Ultimate Edition",
"ClusterName": "cluster1",
"ExposedStatus": 0,
"RiskCount": "{\"account\":0,\"appNum\":0,\"asapVulCount\":0,\"baselineHigh\":0,\"baselineLow\":0,\"baselineMedium\":0,\"baselineNum\":0,\"cmsNum\":0,\"containerAsap\":0,\"containerLater\":0,\"containerNntf\":0,\"containerRemind\":0,\"containerSerious\":0,\"containerSuspicious\":0,\"cveNum\":0,\"emgNum\":0,\"health\":0,\"imageBaselineHigh\":0,\"imageBaselineLow\":0,\"imageBaselineMedium\":0,\"imageBaselineNum\":0,\"imageMaliciousFileRemind\":0,\"imageMaliciousFileSerious\":0,\"imageMaliciousFileSuspicious\":0,\"imageVulAsap\":0,\"imageVulLater\":0,\"imageVulNntf\":0,\"laterVulCount\":0,\"newSuspicious\":0,\"nntfVulCount\":0,\"remindNum\":0,\"scaNum\":0,\"seriousNum\":0,\"suspNum\":0,\"suspicious\":0,\"sysNum\":0,\"trojan\":0,\"uuid\":\"inet-37316411-37fe-4b72-b245-346a2721d4b6\",\"vul\":0,\"weakPWNum\":0}",
"IpListString": "172.31.XX.XX,172.171.XX.XX",
"AssetTypeName": "Elastic Compute Service",
"FlagName": "ASK",
"AppId": "test",
"AppName": "testAppName"
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | NoPermission | no permission | - |
| 400 | RdCheckNoPermission | Resource directory account verification has no permission. | - |
| 403 | NoPermission | caller has no permission | You are not authorized to do this operation. |
| 500 | ServerError | ServerError | - |
| 500 | RdCheckInnerError | Resource directory account service internal error. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-08-01 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-07-20 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-07-04 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2022-12-23 | API Description Update. The API operation is not deprecated.. The Error code has changed | View Change Details |