调用DescribeCloudCenterInstances接口,查询资产信息。

通过资产实例名称、资产实例所属区域等条件搜索指定资产。

调试

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

请求参数

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

要执行的操作。

取值:DescribeCloudCenterInstances

RegionId String cn-hangzhou

实例所在地域的ID。

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

设置搜索资产的条件。该参数格式为:{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.3.4"}

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

资产类型。

取值:

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

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

取值:

  • OR:表示多个条件间是的关系。
  • AND:表示多个条件间是的关系。
PageSize Integer 100

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

CurrentPage Integer 1

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

Importance Integer 2

设置资产重要性。

取值:

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

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
Instances Array of Instance

资产详细信息。

AlarmStatus String NO

当前资产是否存在安全告警。取值:

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

当前资产的类型。取值:

  • ecs:服务器。
  • cloud_product:云产品。
AuthModifyTime Long 1627974044000

资产的授权绑定时间。

AuthVersion Integer 3

资产的授权版本。

取值:

  • 1:免费版(未授权)
  • 6:防病毒版
  • 5:高级版
  • 3:企业版
  • 7:旗舰版
  • 10:独立购买版
AuthVersionName String 免费版

资产的授权版本(具体名称)。

取值:

  • 免费版
  • 防病毒版
  • 高级版
  • 企业版
  • 旗舰版
  • 独立购买版
Bind Boolean true

资产是否已绑定授权。

  • true:已绑定授权
  • false:未绑定授权
ClientStatus String online

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

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

集群ID。

ClusterName String cluster1

集群名称。

Cores Integer 4

资产的CPU核数。

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

资产的CPU信息。

CreatedTime Long 1607365213000

集群创建时间。

ExposedStatus Integer 0

资产暴露状态。取值:

  • 0: 未暴露。
  • 1: 已暴露。
Flag Integer 0

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

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

当前实例所属分组ID。

GroupTrace String 未分组

分组名称。

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.XX.XX

当前实例的公网IP地址。

IntranetIp String 1.2.3.0

当前实例的私网IP地址。

Ip String 1.2.

当前实例的公网IP地址。

IpListString String 172.31.124.228,172.171.0.2

系统的IP列表。

Kernel String 3.10.0-1127.19.1.el7.x86_64

内核版本信息。

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

系统的Mac地址。

Mem Integer 1024

内存(M)。

Os String Linux

当前实例的操作系统。

OsName String CentOS 7.6 64位

当前实例的内核版本。

PodCount Integer 1

容器组个数。

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

当前实例所属区域。

RegionId String cn-hanghzou

当前资产的地域ID。

RegionName String 华北1(青岛)

当前资产的地域名称。

RiskCount String 20

当前资产存在的风险项总数量。

RiskStatus String NO

当前资产是否存在安全风险。取值:

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

当前资产存在的安全告警数量。

Status String Running

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

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

资产实例的标签名称。

TagId String 121313,41412

资产的标签ID。

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

当前实例的UUID。

Vendor Integer 0

资产的类型。

  • 0:表示阿里云服务器。
  • 1:表示第三方云服务器。
  • 2:表示IDC服务器。
  • 3:表腾讯云服务器(仅在资产授权接入后返回该值)。
VendorName String Tencent

资产的服务商名称。

取值:

  • TENCENT:腾讯云。
  • ALIYUN:阿里云。
VpcInstanceId String vpc-uf60agqq65bs98zoo****

当前实例所属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
&<公共请求参数>

正常返回示例

XML格式

<DescribeCloudCenterInstancesResponse>
  <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>华北1(青岛)</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位</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>
</DescribeCloudCenterInstancesResponse>

JSON格式

{
    "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": "华北1(青岛)",
        "ClusterName": "cluster1",
        "ExposedStatus": 0,
        "Status": "Running",
        "VendorName": "Tencent",
        "ClientStatus": "online",
        "SafeEventCount": 5,
        "ClusterId": "c690a0789419f4284a4e0a29e12fe****",
        "InstanceId": "i-m5***",
        "OsName": "CentOS  7.6 64位",
        "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
}

错误码

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