Queries asset information.

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

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 in which the asset resides.

Criteria String No [{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]

The search conditions. The value of this parameter is in the JSON format and is case-sensitive.

Note A search condition can be the instance ID, instance name, VPC ID, region, or public IP address. You can call the DescribeCriteria operation to query the supported search conditions.
MachineTypes String No ecs

The type of the assets that you want to query. Valid values:

  • ecs: servers
  • cloud_product: Alibaba Cloud services
LogicalExp String No OR

The logical relationship among search conditions. Valid values:

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

The number of entries to return on each page. Default value: 20.

CurrentPage Integer No 1

The number of the page to return. Default value: 1.

Importance Integer No 2

The importance of the asset. Valid values:

  • 2: an important asset
  • 1: a common asset
  • 0: a test asset
NoGroupTrace Boolean No false

Specifies whether to internationalize the name of the default group. Valid values:

  • true: The system returns the Chinese name of the default group for the GroupTrace response parameter.
  • false: The system returns default for the GroupTrace response parameter.

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
Success Boolean true

Indicates whether the call is successful. Valid values:

  • true: yes
  • false: no
RequestId String 32A73759-4C0F-4801-BE98-901223ACEE9A

The ID of the request, which is used to locate and troubleshoot issues.

PageInfo Object

The pagination information.

CurrentPage Integer 1

The page number of the returned page.

PageSize Integer 20

The number of entries returned per page. Default value: 20.

TotalCount Integer 50

The total number of entries returned.

Count Integer 10

The number of entries returned on the current page.

Instances Array of Instance

The details about the asset.

Status String Running

The status of the instance. Valid values:

  • Running: running
  • notRunning: stopped
CpuInfo String Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz

The CPU information of the asset.

InternetIp String 1.2.XX.XX

The public IP address of the instance.

Kernel String 3.10.0-1127.19.1.el7.x86_64

The version of the kernel.

Bind Boolean true

Indicates whether Security Center is authorized to scan the asset. Valid values:

  • true: yes
  • false: no
OsName String CentOS 7.6 64-bit

The kernel version of the instance.

Tag String InternetIp,test

The name of the asset tag.

ClientStatus String online

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

  • online: The Security Center agent is enabled.
  • offline: The Security Center agent is disabled.
  • pause: The Security Center agent is suspended.
Mem Integer 1024

The size of the memory. Unit: MB.

VpcInstanceId String vpc-uf60agqq65bs98zoo****

The ID of the VPC to which the instance belongs.

TagId String 121313,41412

The ID of the asset tag.

Flag Integer 0

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

  • 0: yes
  • 1: no
LastLoginTimestamp Long 1637592907000

The timestamp when the Security Center agent was last online. Unit: milliseconds.

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
Region String cn-hangzhou-cm***-***

The region ID of the instance.

InstanceName String yztest-l***

The name of the instance.

PodCount Integer 1

The number of pods.

VulCount Integer 2

The number of vulnerabilities that are detected on the instance.

HcStatus String YES

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

  • YES
  • NO
CreatedTime Long 1607365213000

The timestamp when the cluster was created. Unit: milliseconds.

GroupTrace String default

The name of the group to which the asset belongs.

ClusterId String c690a0789419f4284a4e0a29e12fe****

The ID of the cluster.

RiskStatus String NO

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

  • YES
  • NO
Cores Integer 4

The number of the CPU cores used by the asset.

VulStatus String YES

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

  • YES
  • NO
AlarmStatus String NO

Indicates whether alerts are generated on the asset. Valid values:

  • YES
  • NO
MacListString String 00:13:3e:31:13:39,02:12:67:b8:**:**

The MAC address of the system.

Importance Integer 2

The importance of the asset. Valid values:

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

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

Ip String 1.2.XX.XX

The public IP address of the instance.

Os String Linux

The operating system of the instance.

AuthModifyTime Long 1627974044000

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

SafeEventCount Integer 5

The number of alerts that are generated on the asset.

InstanceId String i-m5***

The ID of the instance.

AssetType String ecs

The type of the asset. Valid values:

  • 0: Elastic Compute Service (ECS) instance
  • 1: Server Load Balancer (SLB) instance
  • 2: Network Address Translation (NAT) gateway
  • 3: ApsaraDB RDS database
  • 4: ApsaraDB for MongoDB database
  • 5: ApsaraDB for Redis database
  • 6: container image
  • 7: container
IntranetIp String 1.2.XX.XX

The private IP address of the instance.

Vendor Integer 0

The type of the asset. Valid values:

  • 0: an 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.
RegionId String cn-hanghzou

The ID of the region in which the asset resides.

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

The UUID of the instance.

GroupId Long 4120080

The ID of the group to which the instance belongs.

RegionName String China (Qingdao)

The name of the region in which the asset resides.

VendorName String Tencent

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

Valid values:

  • TENCENT: Tencent Cloud
  • ALIYUN: Alibaba Cloud
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
ClusterName String cluster1

The name of the cluster.

ExposedStatus Integer 0

Indicates whether the asset is exposed. Valid values:

  • 0: The asset is not exposed.
  • 1: The asset is exposed.
RiskCount String 20

The total number of baseline risks that are detected on the asset.

IpListString String 172.31.XX.XX,172.171.XX.XX

The IP addresses of the system.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCloudCenterInstances
&RegionId=cn-hangzhou
&Criteria=[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]
&MachineTypes=ecs
&LogicalExp=OR
&PageSize=100
&CurrentPage=1
&Importance=2
&NoGroupTrace=false
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCloudCenterInstancesResponse>
    <Success>true</Success>
    <RequestId>32A73759-4C0F-4801-BE98-901223ACEE9A</RequestId>
    <PageInfo>
        <CurrentPage>1</CurrentPage>
        <PageSize>20</PageSize>
        <TotalCount>50</TotalCount>
        <Count>10</Count>
    </PageInfo>
    <Instances>
        <Status>Running</Status>
        <CpuInfo>Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz</CpuInfo>
        <InternetIp>1.2.XX.XX</InternetIp>
        <Kernel>3.10.0-1127.19.1.el7.x86_64</Kernel>
        <Bind>true</Bind>
        <OsName>CentOS 7.6 64-bit</OsName>
        <Tag>InternetIp,test</Tag>
        <ClientStatus>online</ClientStatus>
        <Mem>1024</Mem>
        <VpcInstanceId>vpc-uf60agqq65bs98zoo****</VpcInstanceId>
        <TagId>121313,41412</TagId>
        <Flag>0</Flag>
        <LastLoginTimestamp>1637592907000</LastLoginTimestamp>
        <AuthVersion>3</AuthVersion>
        <Region>cn-hangzhou-cm***-***</Region>
        <InstanceName>yztest-l***</InstanceName>
        <PodCount>1</PodCount>
        <VulCount>2</VulCount>
        <HcStatus>YES</HcStatus>
        <CreatedTime>1607365213000</CreatedTime>
        <GroupTrace>default</GroupTrace>
        <ClusterId>c690a0789419f4284a4e0a29e12fe****</ClusterId>
        <RiskStatus>NO</RiskStatus>
        <Cores>4</Cores>
        <VulStatus>YES</VulStatus>
        <AlarmStatus>NO</AlarmStatus>
        <MacListString>00:13:3e:31:13:39,02:12:67:b8:**:**</MacListString>
        <Importance>2</Importance>
        <HealthCheckCount>1</HealthCheckCount>
        <Ip>1.2.XX.XX</Ip>
        <Os>Linux</Os>
        <AuthModifyTime>1627974044000</AuthModifyTime>
        <SafeEventCount>5</SafeEventCount>
        <InstanceId>i-m5***</InstanceId>
        <AssetType>ecs</AssetType>
        <IntranetIp>1.2.XX.XX</IntranetIp>
        <Vendor>0</Vendor>
        <RegionId>cn-hanghzou</RegionId>
        <Uuid>c9107c04-942f-40c1-981a-f1c1***</Uuid>
        <GroupId>4120080</GroupId>
        <RegionName>China (Qingdao)</RegionName>
        <VendorName>Tencent</VendorName>
        <AuthVersionName>Basic edition</AuthVersionName>
        <ClusterName>cluster1</ClusterName>
        <ExposedStatus>0</ExposedStatus>
        <RiskCount>20</RiskCount>
        <IpListString>172.31.XX.XX,172.171.XX.XX</IpListString>
    </Instances>
</DescribeCloudCenterInstancesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "RequestId" : "32A73759-4C0F-4801-BE98-901223ACEE9A",
  "PageInfo" : {
    "CurrentPage" : 1,
    "PageSize" : 20,
    "TotalCount" : 50,
    "Count" : 10
  },
  "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" : "CentOS 7.6 64-bit",
    "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 (Qingdao)",
    "VendorName" : "Tencent",
    "AuthVersionName" : "Basic edition",
    "ClusterName" : "cluster1",
    "ExposedStatus" : 0,
    "RiskCount" : "20",
    "IpListString" : "172.31.XX.XX,172.171.XX.XX"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 NoPermission no permission The error message returned because you do not have access permissions on the service.
500 ServerError ServerError The error message returned because a server error occurred.

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