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

您可以通过资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产,还可以通过设置不同搜索条件之间的逻辑关系搜索符合多个搜索条件的资产。

调试

您可以在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.XX.XX"}]

设置搜索资产的条件。该参数JSON格式,输入参数时注意大小写。

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

要查询的资产的类型。取值:

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

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

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

设置分页查询时,每页显示的资产的数量。默认值为20,表示每页显示20条资产信息。

CurrentPage Integer 1

设置从返回结果的第几页开始显示查询结果。默认值为1,表示从第1页开始显示。

Importance Integer 2

设置资产重要性。取值:

  • 2:重要资产
  • 1:一般资产
  • 0:测试资产
NoGroupTrace Boolean false

默认分组“未分组”是否要做国际化处理。取值:

  • true:不做国际化处理。即返回参数GroupTrace的取值为云安全中心的默认分组“未分组”时,“未分组”仍然显示为“未分组”。
  • false:需要国际化处理。即返回参数GroupTrace的取值为云安全中心的默认分组“未分组”时,“未分组”显示为“default”。

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

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

返回数据

名称 类型 示例值 描述
Success Boolean true

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

  • true:接口调用成功。
  • false:接口调用失败。
RequestId String 32A73759-4C0F-4801-BE98-901223ACEE9A

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

PageInfo Object

页面显示信息。

CurrentPage Integer 1

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

PageSize Integer 20

分页查询时,每页显示的资产的数量。默认值为20,表示每页显示20条资产信息。

TotalCount Integer 50

查询到的资产的总数量。

Count Integer 10

当前页显示的资产的条数。

Instances Array of Instance

资产详细信息。

Status String Running

实例的运行状态。取值:

  • Running:运行中。
  • notRunning:已关机。
CpuInfo String Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz

资产的CPU信息。

InternetIp String 1.2.XX.XX

实例的公网IP地址。

Kernel String 3.10.0-1127.19.1.el7.x86_64

内核版本信息。

Bind Boolean true

资产是否已绑定授权。取值:

  • true:已绑定授权
  • false:未绑定授权
OsName String CentOS 7.6 64位

实例的内核版本。

Tag String InternetIp,test

资产实例的标签名称。

ClientStatus String online

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

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

内存(M)。

VpcInstanceId String vpc-uf60agqq65bs98zoo****

实例所属VPC的ID。

TagId String 121313,41412

资产的标签ID。

Flag Integer 0

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

  • 0:阿里云资产
  • 1:非阿里云资产
LastLoginTimestamp Long 1637592907000

客户端最后一次在线的时间戳。单位为毫秒。

AuthVersion Integer 3

资产的授权版本。取值:

  • 1:免费版
  • 6:防病毒版
  • 5:高级版
  • 3:企业版
  • 7:旗舰版
  • 10:独立购买版
Region String cn-hangzhou-cm***-***

实例所属地域ID。

InstanceName String yztest-l***

实例名称。

PodCount Integer 1

容器组个数。

VulCount Integer 2

实例上存在的漏洞数量。

HcStatus String YES

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

  • YES:检测出了基线风险项
  • NO:未检测出基线风险项
CreatedTime Long 1607365213000

集群创建的时间戳,单位为毫秒。

GroupTrace String default

资产所在的分组的名称。

ClusterId String c690a0789419f4284a4e0a29e12fe****

集群ID。

RiskStatus String NO

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

  • YES:存在
  • NO:不存在
Cores Integer 4

资产的CPU核数。

VulStatus String YES

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

  • YES:存在漏洞。
  • NO:不存在漏洞。
AlarmStatus String NO

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

  • YES:存在安全告警
  • NO:不存在安全告警
MacListString String 00:13:3e:31:13:39,02:12:67:b8:**:**

系统的Mac地址。

Importance Integer 2

资产的重要性。取值:

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

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

Ip String 1.2.XX.XX

实例的公网IP地址。

Os String Linux

实例的操作系统。

AuthModifyTime Long 1627974044000

资产的授权绑定时间。

SafeEventCount Integer 5

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

InstanceId String i-m5***

实例ID。

AssetType String ecs

资产的类型。取值:

  • 0:云服务器
  • 1:负载均衡
  • 2:NAT网关
  • 3:RDS数据库
  • 4:MongoDb数据库
  • 5:REDIS数据库
  • 6:容器镜像
  • 7:容器
IntranetIp String 1.2.XX.XX

实例的私网IP地址。

Vendor Integer 0

资产的类型。取值:

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

资产所在的地域的ID。

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

实例的UUID。

GroupId Long 4120080

实例所属分组ID。

RegionName String 华北1(青岛)

资产的地域名称。

VendorName String Tencent

资产的服务商名称。

取值:

  • TENCENT:腾讯云。
  • ALIYUN:阿里云。
AuthVersionName String 免费版

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

  • 免费版
  • 防病毒版
  • 高级版
  • 企业版
  • 旗舰版
  • 独立购买版
ClusterName String cluster1

集群名称。

ExposedStatus Integer 0

资产暴露状态。取值:

  • 0: 未暴露
  • 1: 已暴露
RiskCount String 20

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

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

系统的IP列表。

示例

请求示例

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
&公共请求参数

正常返回示例

XML格式

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位</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>华北1(青岛)</RegionName>
        <VendorName>Tencent</VendorName>
        <AuthVersionName>免费版</AuthVersionName>
        <ClusterName>cluster1</ClusterName>
        <ExposedStatus>0</ExposedStatus>
        <RiskCount>20</RiskCount>
        <IpListString>172.31.XX.XX,172.171.XX.XX</IpListString>
    </Instances>
</DescribeCloudCenterInstancesResponse>

JSON格式

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位",
    "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" : "华北1(青岛)",
    "VendorName" : "Tencent",
    "AuthVersionName" : "免费版",
    "ClusterName" : "cluster1",
    "ExposedStatus" : 0,
    "RiskCount" : "20",
    "IpListString" : "172.31.XX.XX,172.171.XX.XX"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 NoPermission no permission 无此服务的访问权限。
500 ServerError ServerError 服务故障

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