You can call this operation to query the information about an asset instance on the Assets page, such as the name and region of the instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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. \"}]

The search conditions, such as instance IDs, instance names, VPC IDs, regions, and IP addresses.

Specify 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\"},{},...

CurrentPage Integer No 1

The number of the page to return.

LogicalExp String No OR

The logical relationship between search conditions. Valid values:

  • OR
  • AND
MachineTypes String No ecs

The type of the instance. Valid values:

  • ecs: ECS instance
  • cloud_product: cloud product
NoPage Boolean No true

Specifies whether to enable paged query. Valid values:

  • true
  • false
PageSize Integer No 20

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
Instances

The instance information.

AlarmStatus String NO

Indicates whether alerts are configured for the instance. Valid values:

  • YES
  • NO
AssetType String ecs

The type of the instance.

ClientStatus String online

Indicates whether the asset is protected by the Security Center agent. Valid values:

  • online: The protection status of the asset is Enabled.
  • offline: The protection status of the asset is Disabled.
  • pause: The protection status of the asset is Paused.
Flag Integer 0

Indicates whether the instance is provided by Alibaba Cloud. Valid values:

  • 0: The instance is provided by Alibaba Cloud.
  • 1: The instance is not provided by Alibaba Cloud.
GroupId String tst-111***

The ID of the group to which the instance belongs.

HcStatus String YES

Indicates whether the instance is exposed to baseline risks. Valid values:

  • YES
  • NO
HealthCheckCount Integer 1

The number of issues that are detected in baseline checks.

InstanceId String i-m5***

The instance ID of the asset.

InstanceName String yztest-l***

The instance name of the asset.

InternetIp String 1.2.3.4

The public IP address of the instance.

IntranetIp String 1.2.3.0

The private IP address of the instance.

Ip String 1.2.3.4

The public IP address of the instance.

Os String Linux

The operating system of the instance.

OsName String CentOS 7.6 64-bit

The kernel version of the instance.

Region String cn-hangzhou-cm***-***

The region where the instance resides.

RegionId String cn-hanghzou

The ID of the region where the instance resides.

RegionName String China (Qingdao)

The name of the region where the instance resides.

RiskStatus String NO

Indicates whether the instance is exposed to security risks. Valid values:

  • YES
  • NO
SafeEventCount Integer 5

The number of alerts.

Status String Running

The status of the instance. Valid values:

  • Running
  • notRunning
Tag String InternetIp

The tag of the instance.

Uuid String c9107c04-942f-40c1-981a-f1c1***

The ID of the user who owns the instance.

VpcInstanceId String classic

The ID of the VPC to which the instance belongs.

VulCount Integer 2

The number of vulnerabilities.

VulStatus String YES

Indicates whether the instance is exposed to vulnerabilities. Valid values:

  • YES
  • NO
PageInfo

The page information.

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 returned entries.

RequestId String 32A73759-4C0F-4801-BE98-901223ACEE9A

The ID of the request.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeCloudCenterInstances
&<Common request parameters>

Sample success responses

XML format

<DescribeCloudCenterInstances>
  <RequestId>32A73759-4C0F-4801-BE98-901223ACEE9A</RequestId>
  <PageInfo>
        <Count>0</Count>
        <TotalCount>691</TotalCount>
        <PageSize>20</PageSize>
        <CurrentPage>1</CurrentPage>
  </PageInfo>
  <Instances>
        <RiskStatus>NO</RiskStatus>
        <Uuid>88f7ce77-595e-4580-b655-3***</Uuid>
        <Ip>1.2.3.4</Ip>
        <Flag>0</Flag>
        <RegionName>China (Hangzhou)</RegionName>
        <OsName>CentOS  7.6 64-bit</OsName>
        <AssetType>0</AssetType>
        <InstanceId>i-m5e50***</InstanceId>
        <InternetIp>1.2.3.4</InternetIp>
        <HealthCheckCount>0</HealthCheckCount>
        <HcStatus>NO</HcStatus>
        <Os>linux</Os>
        <ClientStatus>online</ClientStatus>
        <Status>Running</Status>
        <Region>cn-hangzhou-cm***-***</Region>
        <VpcInstanceId>classic</VpcInstanceId>
        <VulStatus>NO</VulStatus>
        <Tag>InternetIp</Tag>
        <RegionId>cn-hangzhou</RegionId>
        <IntranetIp>1.2.3.0</IntranetIp>
        <AlarmStatus>NO</AlarmStatus>
        <VulCount>0</VulCount>
        <SafeEventCount>0</SafeEventCount>
        <InstanceName>yztest-l***</InstanceName>
  </Instances>
  <Instances>
        <RiskStatus>NO</RiskStatus>
        <Uuid>7a4735d6-75a4-4555-a18f-b***</Uuid>
        <Ip>1.2.3.4</Ip>
        <Flag>0</Flag>
        <RegionName>China (Hangzhou)</RegionName>
        <OsName>CentOS  7.6 64-bit</OsName>
        <AssetType>0</AssetType>
        <InstanceId>i-m5e5***</InstanceId>
        <InternetIp>1.2.3.4</InternetIp>
        <HealthCheckCount>0</HealthCheckCount>
        <HcStatus>NO</HcStatus>
        <Os>linux</Os>
        <ClientStatus>online</ClientStatus>
        <Status>Running</Status>
        <Region>cn-hangzhou-cm***-***</Region>
        <VpcInstanceId>classic</VpcInstanceId>
        <VulStatus>NO</VulStatus>
        <Tag>InternetIp</Tag>
        <RegionId>cn-hangzhou</RegionId>
        <IntranetIp>1.2.3.0</IntranetIp>
        <AlarmStatus>NO</AlarmStatus>
        <VulCount>0</VulCount>
        <SafeEventCount>0</SafeEventCount>
        <InstanceName>yztest-l***</InstanceName>
  </Instances>
  <Success>true</Success>
</DescribeCloudCenterInstances>

JSON format

{
	"RequestId":"32A73759-4C0F-4801-BE98-901223ACEE9A",
	"Instances":[
		{
			"RiskStatus":"NO",
			"Uuid":"88f7ce77-595e-4580-b655-3***",
			"Ip":"1.2.3.4",
			"Flag":0,
			"RegionName":"China (Hangzhou)",
			"OsName":"CentOS  7.6 64-bit",
			"AssetType":"0",
			"InstanceId":"i-m5e50***",
			"InternetIp":"1.2.3.4",
			"HealthCheckCount":0,
			"HcStatus":"NO",
			"Os":"linux",
			"Status":"Running",
			"ClientStatus":"online",
			"Region":"cn-hangzhou-cm***-***",
			"VpcInstanceId":"classic",
			"Tag":"InternetIp",
			"VulStatus":"NO",
			"IntranetIp":"1.2.3.0",
			"RegionId":"cn-hangzhou",
			"AlarmStatus":"NO",
			"VulCount":0,
			"InstanceName":"yztest-l***",
			"SafeEventCount":0
		},
		{
			"RiskStatus":"NO",
			"Uuid":"7a4735d6-75a4-4555-a18f-b***",
			"Ip":"1.2.3.4",
			"Flag":0,
			"RegionName":"China (Hangzhou)",
			"OsName":"CentOS  7.6 64-bit",
			"AssetType":"0",
			"InstanceId":"i-m5e5***",
			"InternetIp":"1.2.3.4",
			"HealthCheckCount":0,
			"HcStatus":"NO",
			"Os":"linux",
			"Status":"Running",
			"ClientStatus":"online",
			"Region":"cn-hangzhou-cm***-***",
			"VpcInstanceId":"classic",
			"Tag":"InternetIp",
			"VulStatus":"NO",
			"IntranetIp":"1.2.3.0",
			"RegionId":"cn-hangzhou",
			"AlarmStatus":"NO",
			"VulCount":0,
			"InstanceName":"yztest-l***",
			"SafeEventCount":0
		}
	],
	"PageInfo":{
		"Count":0,
		"TotalCount":691,
		"PageSize":20,
		"CurrentPage":1
	},
	"Success":true
}

Error codes

For a list of error codes, visit the API Error Center.