You can call this operation to query the information about assets that meet specific search conditions. For example, you can search assets by instance name or region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeCloudCenterInstances |
The operation that you want to perform. Set the value to DescribeCloudCenterInstances. |
Criteria | String | No | [{\"name\":\"riskStatus\",\"value\":\"YES\"},{\"name\":\"internetIp\",\"value\":\"1.2.3.4\"}] |
Specifies the search conditions. Set this parameter in the following format: [{\"name\":\"Name of condition 1\",\"value\":\"Value of condition 1\"},{\"name\":\"Name of condition 2\",\"value\":\"Value of condition 2\"},{},...]. Note Supported search conditions include the instance ID, instance name, Virtual Private
Cloud (VPC) ID, region, and public IP address. You can call the DescribeCriteria operation to query the supported search conditions.
|
MachineTypes | String | No | ecs |
The type of the asset. Valid values:
|
LogicalExp | String | No | OR |
The logical relationship between search conditions. Valid values:
|
NoPage | Boolean | No | true |
Specifies whether to enable paged query. Valid values:
|
PageSize | Integer | No | 20 |
The number of entries to return on each page. |
CurrentPage | Integer | No | 1 |
The number of the page to return. Pages start from page 1. |
Importance | Integer | No | 2 |
The importance of the asset. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Instances | Array |
The asset details. |
|
AlarmStatus | String | NO |
Indicates whether the current instance contains security alerts. Valid values:
|
AssetType | String | ecs |
The asset type of the current instance. Valid values:
|
ClientStatus | String | online |
The status of the Security Center agent installed on the current instance. Valid values:
|
Flag | Integer | 0 |
Indicates whether the instance is an Alibaba Cloud asset. Valid values:
|
GroupId | String | 4120080 |
The ID of the group to which the instance belongs. |
HcStatus | String | YES |
Indicates whether the current instance contains baseline risks. Valid values:
|
HealthCheckCount | Integer | 1 |
The number of baseline risks that the current instance contains. |
Importance | Integer | 2 |
The importance of the current asset. Valid values:
|
InstanceId | String | i-m5*** |
The ID of the current instance. |
InstanceName | String | yztest-l*** |
The name of the current instance. |
InternetIp | String | 1.2.3.4 |
The public IP address of the current instance. |
IntranetIp | String | 1.2.3.0 |
The private IP address of the current instance. |
Ip | String | 1.2.3.4 |
The public IP address of the current instance. |
Os | String | Linux |
The operating system that the current instance runs. |
OsName | String | CentOS 7.6 64-bit |
The kernel version of the current instance. |
Region | String | cn-hangzhou-cm***-*** |
The region to which the current instance belongs. |
RegionId | String | cn-hanghzou |
The ID of the region to which the current instance belongs. |
RegionName | String | China (Qingdao) |
The name of the region to which the current instance belongs. |
RiskStatus | String | NO |
Indicates whether the current instance contains security risks. Valid values:
|
SafeEventCount | Integer | 5 |
The number of security alerts that the current instance contains. |
Status | String | Running |
The running status of the current instance. Valid values:
|
Tag | String | InternetIp |
The tag of the current instance. |
Uuid | String | c9107c04-942f-40c1-981a-f1c1*** |
The UUID of the current instance. |
VpcInstanceId | String | classic |
The ID of the VPC to which the current instance belongs. |
VulCount | Integer | 2 |
The number of vulnerabilities that the current instance contains. |
VulStatus | String | YES |
Indicates whether the current instance contains vulnerabilities. Valid values:
|
PageInfo | Struct |
The information displayed on the page. |
|
Count | Integer | 10 |
The number of entries returned on the current page. |
CurrentPage | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 20 |
The number of entries returned per page. |
TotalCount | Integer | 50 |
The total number of entries returned. |
RequestId | String | 32A73759-4C0F-4801-BE98-901223ACEE9A |
The ID of the request. |
Success | Boolean | true |
The result of the operation. Valid values:
|
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeCloudCenterInstances
&Criteria=[{\"name\":\"riskStatus\",\"value\":\"YES\"},{\"name\":\"internetIp\",\"value\":\"1.2.3.4\"}]
&<Common request parameters>
Sample success responses
XML
format
<DescribeCloudCenterInstancesResponse>
<Instances>
<Os>Linux</Os>
<VulStatus>YES</VulStatus>
<Ip>1.2.3.4</Ip>
<IntranetIp>1.2.3.0</IntranetIp>
<Importance>2</Importance>
<InternetIp>1.2.3.4</InternetIp>
<RegionName>China (Qingdao)</RegionName>
<Status>Running</Status>
<ClientStatus>online</ClientStatus>
<SafeEventCount>5</SafeEventCount>
<InstanceId>i-m5***</InstanceId>
<OsName>CentOS 7.6 64-bit</OsName>
<HealthCheckCount>1</HealthCheckCount>
<Flag>0</Flag>
<RiskStatus>NO</RiskStatus>
<VulCount>2</VulCount>
<GroupId>4120080</GroupId>
<InstanceName>yztest-l***</InstanceName>
<AssetType>ecs</AssetType>
<Uuid>c9107c04-942f-40c1-981a-f1c1***</Uuid>
<AlarmStatus>NO</AlarmStatus>
<Region>cn-hangzhou-cm***-***</Region>
<VpcInstanceId>classic</VpcInstanceId>
<Tag>InternetIp</Tag>
<RegionId>cn-hanghzou</RegionId>
<HcStatus>YES</HcStatus>
</Instances>
<PageInfo>
<TotalCount>50</TotalCount>
<PageSize>20</PageSize>
<CurrentPage>1</CurrentPage>
<Count>10</Count>
</PageInfo>
<RequestId>32A73759-4C0F-4801-BE98-901223ACEE9A</RequestId>
<Success>true</Success>
</DescribeCloudCenterInstancesResponse>
JSON
format
{
"Instances": [{
"Os": "Linux",
"VulStatus": "YES",
"Ip": "1.2.3.4",
"IntranetIp": "1.2.3.0",
"Importance": "2",
"InternetIp": "1.2.3.4",
"RegionName": "China (Qingdao)",
"Status": "Running",
"ClientStatus": "online",
"SafeEventCount": "5",
"InstanceId": "i-m5***",
"OsName": "CentOS 7.6 64-bit",
"HealthCheckCount": "1",
"Flag": "0",
"RiskStatus": "NO",
"VulCount": "2",
"GroupId": "4120080",
"InstanceName": "yztest-l***",
"AssetType": "ecs",
"Uuid": "c9107c04-942f-40c1-981a-f1c1***",
"AlarmStatus": "NO",
"Region": "cn-hangzhou-cm***-***",
"VpcInstanceId": "classic",
"Tag": "InternetIp",
"RegionId": "cn-hanghzou",
"HcStatus": "YES"
}],
"PageInfo": {
"TotalCount": "50",
"PageSize": "20",
"CurrentPage": "1",
"Count": "10"
},
"RequestId": "32A73759-4C0F-4801-BE98-901223ACEE9A",
"Success": "true"
}
Error codes
For a list of error codes, visit the API Error Center.