调用DescribeCloudCenterInstances接口通过设置搜索条件查询符合条件的资产信息,例如通过资产实例名称、资产实例所属区域等条件搜索指定资产。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCloudCenterInstances

要执行的操作。

取值:DescribeCloudCenterInstances

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

设置搜索资产的条件。该参数格式为:[{\"name\":\"条件1名称\",\"value\":\"条件1值\"},{\"name\":\"条件2名称\",\"value\":\"条件2值\"},{},...]。

说明 支持使用实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用DescribeCriteria接口查询支持的搜索条件。
MachineTypes String ecs

资产类型。取值:

  • ecs:服务器。
  • cloud_product:云产品。
LogicalExp String OR

设置多个搜索条件间生效的逻辑关系。取值:

  • OR:表示多个条件间是的关系。
  • AND:表示多个条件间是的关系。
NoPage Boolean true

设置是否分页查询。取值:

  • true:表示进行分页查询数据。
  • false:表示不进行分页查询数据。
PageSize Integer 20

分页查询时,每页显示的数据最大条数。

CurrentPage Integer 1

分页查询时,当前页的页码。

Importance Integer 2

设置资产重要性。取值:

  • 2:重要资产。
  • 1:一般资产。
  • 0:测试资产。

返回数据

名称 类型 示例值 描述
Instances Array

资产详细信息。

AlarmStatus String NO

当前实例是否存在安全告警。取值:

  • YES:存在安全告警。
  • NO:不存在安全告警。
AssetType String ecs

当前实例的资产类型。取值:

  • ecs:服务器。
  • cloud_product:云产品。
ClientStatus String online

当前实例的客户端在线状态。取值:

  • online:在线,表示资产的Agent客户端状态为开启
  • offline:离线,表示资产的Agent客户端状态为关闭
  • pause:暂停,表示资产的Agent客户端状态为暂停保护
Flag Integer 0

当前实例是否为阿里云资产。取值:

  • 0:阿里云资产。
  • 1:非阿里云资产。
GroupId String 4120080

当前实例所属分组ID。

HcStatus String YES

当前实例是否检测出了基线风险项。取值:

  • YES:检测出了基线风险项。
  • NO:未检测出基线风险项。
HealthCheckCount Integer 1

当前实例中存在的基线风险项数量。

Importance Integer 2

当前资产的重要性。取值:

  • 2:重要资产。
  • 1:一般资产。
  • 0:测试资产。
InstanceId String i-m5***

当前实例ID。

InstanceName String yztest-l***

当前实例名称。

InternetIp String 1.2.3.4

当前实例的公网IP地址。

IntranetIp String 1.2.3.0

当前实例的私网IP地址。

Ip String 1.2.3.4

当前实例的公网IP地址。

Os String Linux

当前实例的操作系统。

OsName String CentOS 7.6 64位

当前实例的内核版本。

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

当前实例所属区域。

RegionId String cn-hanghzou

当前实例所属地域ID。

RegionName String 华北1(青岛)

当前实例所属地域名称。

RiskStatus String NO

当前实例是否存在安全风险。取值:

  • YES:存在。
  • NO:不存在。
SafeEventCount Integer 5

当前实例存在的安全告警数量。

Status String Running

当前实例的运行状态。取值:

  • Running:运行中。
  • notRunning:已关机。
Tag String InternetIp

资产实例所属标签名称。

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

当前实例的UUID。

VpcInstanceId String classic

当前实例的所属VPC ID。

VulCount Integer 2

当前实例上存在的漏洞数量。

VulStatus String YES

当前实例是否存在漏洞。取值:

  • YES:存在漏洞。
  • NO:不存在漏洞。
PageInfo Struct

页面显示信息。

Count Integer 10

当前页显示的数据条数。

CurrentPage Integer 1

当前页的页码。

PageSize Integer 20

每页显示数据条数。

TotalCount Integer 50

数据的总条数。

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

阿里云为该请求生成的唯一标识符。

Success Boolean true

接口调用的结果状态。取值:

  • true:请求成功。
  • false:请求失败。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCloudCenterInstances
&Criteria=[{\"name\":\"riskStatus\",\"value\":\"YES\"},{\"name\":\"internetIp\",\"value\":\"1.2.3.4\"}]
&<公共请求参数>

正常返回示例

XML 格式

<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>华北1(青岛)</RegionName>
            <Status>Running</Status>
            <ClientStatus>online</ClientStatus>
            <SafeEventCount>5</SafeEventCount>
            <InstanceId>i-m5***</InstanceId>
            <OsName>CentOS  7.6 64位</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 格式

{
	"Instances": [{
		"Os": "Linux",
		"VulStatus": "YES",
		"Ip": "1.2.3.4",
		"IntranetIp": "1.2.3.0",
		"Importance": "2",
		"InternetIp": "1.2.3.4",
		"RegionName": "华北1(青岛)",
		"Status": "Running",
		"ClientStatus": "online",
		"SafeEventCount": "5",
		"InstanceId": "i-m5***",
		"OsName": "CentOS  7.6 64位",
		"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"
}

错误码

访问错误中心查看更多错误码。