Queries asset information.

You can search for an asset by using search conditions, such as the name and region of the asset.

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.

RegionId String No cn-hangzhou

The ID of the region where the instance resides.

Criteria String No [{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.3.4"}]

The search conditions. The value of this parameter is in the format of {"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.3.4"}.

Note Supported search conditions include the instance ID, instance name, ID of the virtual private cloud (VPC), region, and public IP address. The value is case-sensitive. You can call the DescribeCriteria operation to query the supported search conditions.
MachineTypes String No ECS

The type of the asset.

Valid values:

  • ecs: an Elastic Compute Service (ECS) instance
  • cloud_product: an Alibaba Cloud service
LogicalExp String No OR

The logical relationship between search conditions.

Valid values:

  • OR: The logical relationship between search conditions is OR.
  • AND: The logical relationship between search conditions is AND.
PageSize Integer No 100

The number of entries to return on each page.

CurrentPage Integer No 1

The page number of the current page.

Importance Integer No 2

The importance of the asset.

Valid values:

  • 2: an important asset
  • 1: a common asset
  • 0: a test asset

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
Instances Array of Instance

The details of the asset.

AlarmStatus String NO

Indicates whether security alerts are generated for the current asset. Valid values:

  • YES
  • NO
AssetType String ecs

The type of the current asset. Valid values:

  • ecs: an ECS instance
  • cloud_product: an Alibaba Cloud service
AuthModifyTime Long 1627974044000

The timestamp of when Security Center is authorized to scan the asset.

AuthVersion Integer 3

The edition of Security Center that is authorized to scan the asset.

Valid values:

  • 1: Basic edition
  • 6: Anti-virus edition
  • 5: Advanced edition
  • 3: Enterprise edition
  • 7: Ultimate edition
  • 10: Value-added Plan edition
AuthVersionName String Basic edition

The name of the Security Center edition that is authorized to scan the asset.

Valid values:

  • Basic edition
  • Anti-virus edition
  • Advanced edition
  • Enterprise edition
  • Ultimate edition
  • Value-added Plan edition
Bind Boolean true

Indicates whether Security Center is authorized to scan the asset.

  • true: Security Center is authorized to scan the asset.
  • false: Security Center is not authorized to scan the asset.
ClientStatus String online

The status of the Security Center agent installed on the current instance. Valid values:

  • online: The Security Center agent is enabled.
  • offline: The Security Center agent is disabled.
  • pause: The Security Center agent is suspended.
ClusterId String c690a0789419f4284a4e0a29e12fe****

The ID of the cluster.

ClusterName String cluster1

The name of the cluster.

Cores Integer 4

The number of the CPU cores used by the asset.

CpuInfo String Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz

The CPU information of the asset.

CreatedTime Long 1607365213000

The timestamp of when the cluster was created.

ExposedStatus Integer 0

Indicates whether the asset was exposed. Valid values:

  • 0: The asset was not exposed.
  • 1: The asset was exposed.
Flag Integer 0

Indicates whether the instance is an Alibaba Cloud asset. Valid values:

  • 0: The asset is an Alibaba Cloud asset.
  • 1: The asset is not an Alibaba Cloud asset.
GroupId String 4120080

The ID of the group to which the instance belongs.

GroupTrace String Ungrouped

The name of the group.

HcStatus String YES

Indicates whether baseline risks are detected on the current instance. Valid values:

  • YES
  • NO
HealthCheckCount Integer 1

The number of baseline risks that are detected on the current instance.

Importance Integer 2

The importance of the current asset. Valid values:

  • 2: an important asset
  • 1: a common asset
  • 0: a test asset
InstanceId String i-m5***

The ID of the current instance.

InstanceName String yztest-l***

The name of the current instance.

InternetIp String 1.2.XX.XX

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.

The public IP address of the current instance.

IpListString String 172.31.124.228,172.171.0.2

The IP addresses of the system.

Kernel String 3.10.0-1127.19.1.el7.x86_64

The version of the kernel.

MacListString String 00:13:3e:31:13:39,02:12:67:b8:e8:09

The MAC addresses of the system.

Mem Integer 1024

The size of the memory. Unit: MB.

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.

PodCount Integer 1

The number of pods.

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

The region of the current instance.

RegionId String cn-hanghzou

The ID of the region where the current asset resides.

RegionName String China (Qingdao)

The name of the region for the current asset.

RiskCount String 20

The total number of risk items that are detected on the current asset.

RiskStatus String NO

Indicates whether security risks are detected on the current asset. Valid values:

  • YES
  • NO
SafeEventCount Integer 5

The number of security alerts that are generated for the current asset.

Status String Running

Indicates whether the current instance is running. Valid values:

  • Running: The instance is running.
  • notRunning: The instance is stopped.
Tag String InternetIp,test

The name of the asset tag.

TagId String 121313,41412

The ID of the asset tag.

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

The UUID of the current instance.

Vendor Integer 0

The type of the asset.

  • 0: an Alibaba Cloud ECS instance.
  • 1: a third-party cloud server.
  • 2: a server in a data center.
  • 3: a server deployed on Tencent Cloud. This value is returned only after the asset is protected by Security Center.
VendorName String Tencent

The name of the service provider (SP) for the asset.

Valid values:

  • TENCENT: Tencent Cloud
  • ALIYUN: Alibaba Cloud
VpcInstanceId String vpc-uf60agqq65bs98zoo****

The ID of the VPC in which the current instance is deployed.

VulCount Integer 2

The number of vulnerabilities that are detected on the current instance.

VulStatus String YES

Indicates whether vulnerabilities are detected on the current instance. Valid values:

  • YES
  • NO
PageInfo Struct

The pagination information.

Count Integer 10

The number of entries returned on the current page.

CurrentPage Integer 1

The page number of the current 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

The result of the operation call. Valid values:

  • true: succeeded
  • false: failed

Examples

Sample requests

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

Sample success responses

XML format

<DescribeCloudCenterInstances>
<Instances>
    <Bind>true</Bind>
    <CreatedTime>1607365213000</CreatedTime>
    <Os>Linux</Os>
    <VulStatus>YES</VulStatus>
    <ExposedCount>1</ExposedCount>
    <Ip>1.2.</Ip>
    <ClientVersion>1.X.X</ClientVersion>
    <IntranetIp>1.2.3.0</IntranetIp>
    <RiskCount>20</RiskCount>
    <AuthModifyTime>1627974044000</AuthModifyTime>
    <PodCount>1</PodCount>
    <Importance>2</Importance>
    <AutoSnapshotsLevel>1</AutoSnapshotsLevel>
    <InternetIp>1.2.XX.XX</InternetIp>
    <RegionName>China (Qingdao)</RegionName>
    <ClusterName>cluster1</ClusterName>
    <ExposedStatus>0</ExposedStatus>
    <Status>Running</Status>
    <VendorName>Tencent</VendorName>
    <ClientStatus>online</ClientStatus>
    <SafeEventCount>5</SafeEventCount>
    <ClusterId>c690a0789419f4284a4e0a29e12fe****</ClusterId>
    <InstanceId>i-m5***</InstanceId>
    <OsName>CentOS 7.6 64-bit</OsName>
    <Vendor>0</Vendor>
    <HealthCheckCount>1</HealthCheckCount>
    <RiskStatus>NO</RiskStatus>
    <Flag>0</Flag>
    <GroupId>4120080</GroupId>
    <VulCount>2</VulCount>
    <Cores>4</Cores>
    <InstanceName>yztest-l***</InstanceName>
    <AssetType>ecs</AssetType>
    <Uuid>c9107c04-942f-40c1-981a-f1c1***</Uuid>
    <AlarmStatus>NO</AlarmStatus>
    <Region>cn-hangzhou-cm***-***</Region>
    <VpcInstanceId>vpc-uf60agqq65bs98zoo****</VpcInstanceId>
    <RegionId>cn-hanghzou</RegionId>
    <Tag>InternetIp</Tag>
    <AuthVersion>3</AuthVersion>
    <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>
</DescribeCloudCenterInstances>

JSON format

{"Instances":[{"Bind":"true","CreatedTime":"1607365213000","Os":"Linux","VulStatus":"YES","ExposedCount":"1","Ip":"1.2.","ClientVersion":"1.X.X","IntranetIp":"1.2.3.0","RiskCount":"20","AuthModifyTime":"1627974044000","PodCount":"1","Importance":"2","AutoSnapshotsLevel":"1","InternetIp":"1.2.XX.XX","RegionName":"China (Qingdao)","ClusterName":"cluster1","ExposedStatus":"0","Status":"Running","VendorName":"Tencent","ClientStatus":"online","SafeEventCount":"5","ClusterId":"c690a0789419f4284a4e0a29e12fe****","InstanceId":"i-m5***","OsName":"CentOS 7.6 64-bit","Vendor":"0","HealthCheckCount":"1","RiskStatus":"NO","Flag":"0","GroupId":"4120080","VulCount":"2","Cores":"4","InstanceName":"yztest-l***","AssetType":"ecs","Uuid":"c9107c04-942f-40c1-981a-f1c1***","AlarmStatus":"NO","Region":"cn-hangzhou-cm***-***","VpcInstanceId":"vpc-uf60agqq65bs98zoo****","RegionId":"cn-hanghzou","Tag":"InternetIp","AuthVersion":"3","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.