首页 云安全中心 API参考指南 API目录 资产管理 DescribeCloudCenterInstances - 查询资产信息

DescribeCloudCenterInstances - 查询资产信息

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

要查询的实例所在地域的ID。

cn-hangzhou
Criteriastring

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

说明支持使用资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用DescribeCriteria接口查询支持的搜索条件。
[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]
MachineTypesstring

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

  • ecs:服务器。
  • cloud_product:云产品。
ecs
LogicalExpstring

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

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

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

100
CurrentPageinteger

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

1
Importanceinteger

设置资产重要性。取值:

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

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

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

设置请求和接收消息的语言类型,默认为zh。取值:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object
Successboolean

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

  • true:接口调用成功。
  • false:接口调用失败。
true
RequestIdstring

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

32A73759-4C0F-4801-BE98-901223ACEE9A
PageInfoobject

页面显示信息。

CurrentPageinteger

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

1
PageSizeinteger

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

20
TotalCountinteger

查询到的资产的总数量。

50
Countinteger

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

10
Instancesarray

资产详细信息。

object
Statusstring

实例的运行状态。取值:

  • Running:运行中。
  • notRunning:已关机。
Running
CpuInfostring

资产的CPU信息。

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

实例的公网IP地址。

1.2.XX.XX
Kernelstring

内核版本信息。

3.10.0-1127.19.1.el7.x86_64
Bindboolean

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

  • true:已绑定授权
  • false:未绑定授权
true
OsNamestring

实例的内核版本。

-
Tagstring

资产实例的标签名称。

InternetIp,test
ClientStatusstring

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

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

内存(MB)。

1024
VpcInstanceIdstring

实例所属VPC的ID。

vpc-uf60agqq65bs98zoo****
TagIdstring

资产的标签ID。

121313,41412
Flaginteger

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

  • 0:阿里云资产
  • 1:非阿里云资产
0
LastLoginTimestamplong

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

1637592907000
AuthVersioninteger

资产的授权版本。取值:

  • 1:免费版
  • 6: 防病毒版
  • 5:高级版
  • 3:企业版
  • 7: 旗舰版
1
Regionstring

实例所属地域ID。

cn-hangzhou-cm***-***
InstanceNamestring

实例名称。

yztest-l***
PodCountinteger

容器组个数。

1
VulCountinteger

实例上存在的漏洞数量。

2
HcStatusstring

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

  • YES:检测出了基线风险项
  • NO:未检测出基线风险项
YES
CreatedTimelong

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

1607365213000
GroupTracestring

资产所在的分组的名称。

default
ClusterIdstring

集群ID。

c690a0789419f4284a4e0a29e12fe****
RiskStatusstring

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

  • YES:存在
  • NO:不存在
NO
Coresinteger

资产的CPU核数。

4
VulStatusstring

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

  • YES:存在漏洞。
  • NO:不存在漏洞。
YES
AlarmStatusstring

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

  • YES:存在安全告警
  • NO:不存在安全告警
NO
MacListStringstring

系统的Mac地址。

00:13:3e:31:13:39,02:12:67:b8:**:**
Importanceinteger

资产的重要性。取值:

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

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

1
Ipstring

实例的公网IP地址。

1.2.XX.XX
Osstring

实例的操作系统。

Linux
AuthModifyTimelong

资产的授权绑定时间戳。单位:毫秒。

1627974044000
SafeEventCountinteger

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

5
InstanceIdstring

实例ID。

i-m5***
AssetTypestring

资产的类型。取值:

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

实例的私网IP地址。

1.2.XX.XX
Vendorinteger

资产厂商。取值:

  • 0:阿里云资产
  • 1:云外资产
  • 2:IDC资产
  • 3457:其它云资产
  • 8:轻量级资产
0
RegionIdstring

资产所在的地域的ID。

cn-hanghzou
Uuidstring

实例的UUID。

c9107c04-942f-40c1-981a-f1c1***
GroupIdlong

实例所属分组ID。

4120080
RegionNamestring

资产的地域名称。

China (Hangzhou)
VendorNamestring

资产的服务商名称。

取值:

  • ALIYUN:阿里云
  • OUT:云外资产
  • IDC:IDC
  • TENCENT:其它云
  • HUAWEICLOUD:其它云
  • Microsoft:其它云
  • AWS:其它云
  • TRIPARTITE:轻量级服务器
IDC
AuthVersionNamestring

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

  • 免费版
  • 防病毒版
  • 高级版
  • 企业版
  • 旗舰版
  • 独立购买版
Ultimate Edition
ClusterNamestring

集群名称。

cluster1
ExposedStatusinteger

资产暴露状态。取值:

  • 0: 未暴露
  • 1: 已暴露
0
RiskCountstring

资产存在的风险项统计。JSON格式,包含以下字段:

  • account:异地登录和爆破成功的账号数量
  • appNum:扫描器漏洞数量
  • asapVulCount:高危漏洞总数量
  • baselineHigh:高危基线风险数量
  • baselineLow:低危基线风险数量
  • baselineMedium:中危基线风险数量
  • baselineNum: 云产品配置风险总数量
  • cmsNum: WEB-CMS漏洞数量
  • containerAsap: 容器高危漏洞数量
  • containerLater:容器中危漏洞数量
  • containerNntf: 容器低危漏洞数量
  • containerRemind:容器提醒告警数量
  • containerSerious:容器紧急告警数量
  • containerSuspicious:容器可疑告警数量
  • cveNum:Linux 漏洞数量
  • emgNum:应急漏洞数量
  • health:未处理的基线告警数量
  • imageBaselineHigh:镜像高危基线风险数量
  • imageBaselineLow:镜像低危基线风险数量
  • imageBaselineMedium:镜像中危基线风险数量
  • imageBaselineNum:镜像基线风险总数量
  • imageMaliciousFileRemind:镜像提醒恶意文件数量
  • imageMaliciousFileSerious:镜像紧急恶意文件数量
  • imageMaliciousFileSuspicious:镜像可疑恶意文件数量
  • imageVulAsap:镜像高危漏洞数量
  • imageVulLater:镜像中危漏洞数量
  • imageVulNntf:镜像低危漏洞数量
  • laterVulCount:中危漏洞数量
  • newSuspicious:告警数量
  • nntfVulCount:低危漏洞数量
  • remindNum:提醒告警数量
  • scaNum:软件成分分析漏洞数量
  • seriousNum:紧急告警数量
  • suspNum:可疑告警数量
  • suspicious:告警总数量
  • sysNum:Windows漏洞数量
  • trojan:木马数量
  • uuid:资产UUID
  • vul:漏洞数量
  • weakPWNum:弱口令数量
{ "account": 0, "appNum": 0, "asapVulCount": 0, "baselineHigh": 0, "baselineLow": 0, "baselineMedium": 0, "baselineNum": 0, "cmsNum": 0, "containerAsap": 0, "containerLater": 0, "containerNntf": 0, "containerRemind": 0, "containerSerious": 0, "containerSuspicious": 0, "cveNum": 0, "emgNum": 0, "health": 0, "imageBaselineHigh": 0, "imageBaselineLow": 0, "imageBaselineMedium": 0, "imageBaselineNum": 0, "imageMaliciousFileRemind": 0, "imageMaliciousFileSerious": 0, "imageMaliciousFileSuspicious": 0, "imageVulAsap": 0, "imageVulLater": 0, "imageVulNntf": 0, "laterVulCount": 0, "newSuspicious": 0, "nntfVulCount": 0, "remindNum": 0, "scaNum": 0, "seriousNum": 0, "suspNum": 0, "suspicious": 0, "sysNum": 0, "trojan": 0, "uuid": "inet-37316411-37fe-4b72-b245-346a2721****", "vul": 0, "weakPWNum": 0 }
IpListStringstring

系统的IP列表。

172.31.XX.XX,172.171.XX.XX

示例

正常返回示例

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": "-",
      "Tag": "InternetIp,test",
      "ClientStatus": "online",
      "Mem": 1024,
      "VpcInstanceId": "vpc-uf60agqq65bs98zoo****",
      "TagId": "121313,41412",
      "Flag": 0,
      "LastLoginTimestamp": 1637592907000,
      "AuthVersion": 1,
      "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": "0",
      "IntranetIp": "1.2.XX.XX",
      "Vendor": 0,
      "RegionId": "cn-hanghzou",
      "Uuid": "c9107c04-942f-40c1-981a-f1c1***",
      "GroupId": 4120080,
      "RegionName": "China (Hangzhou)",
      "VendorName": "IDC",
      "AuthVersionName": "Ultimate Edition",
      "ClusterName": "cluster1",
      "ExposedStatus": 0,
      "RiskCount": "{\n      \"account\": 0,\n      \"appNum\": 0,\n      \"asapVulCount\": 0,\n      \"baselineHigh\": 0,\n      \"baselineLow\": 0,\n      \"baselineMedium\": 0,\n      \"baselineNum\": 0,\n      \"cmsNum\": 0,\n      \"containerAsap\": 0,\n      \"containerLater\": 0,\n      \"containerNntf\": 0,\n      \"containerRemind\": 0,\n      \"containerSerious\": 0,\n      \"containerSuspicious\": 0,\n      \"cveNum\": 0,\n      \"emgNum\": 0,\n      \"health\": 0,\n      \"imageBaselineHigh\": 0,\n      \"imageBaselineLow\": 0,\n      \"imageBaselineMedium\": 0,\n      \"imageBaselineNum\": 0,\n      \"imageMaliciousFileRemind\": 0,\n      \"imageMaliciousFileSerious\": 0,\n      \"imageMaliciousFileSuspicious\": 0,\n      \"imageVulAsap\": 0,\n      \"imageVulLater\": 0,\n      \"imageVulNntf\": 0,\n      \"laterVulCount\": 0,\n      \"newSuspicious\": 0,\n      \"nntfVulCount\": 0,\n      \"remindNum\": 0,\n      \"scaNum\": 0,\n      \"seriousNum\": 0,\n      \"suspNum\": 0,\n      \"suspicious\": 0,\n      \"sysNum\": 0,\n      \"trojan\": 0,\n      \"uuid\": \"inet-37316411-37fe-4b72-b245-346a2721****\",\n      \"vul\": 0,\n      \"weakPWNum\": 0\n}",
      "IpListString": "172.31.XX.XX,172.171.XX.XX"
    }
  ]
}

错误码

Http code错误码错误信息描述
400AccountIdNotExistAccountIdNotExist-
400NoPermissionno permission无此服务的访问权限。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障

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

变更历史

变更时间变更内容概要操作
2022-12-23OpenAPI 描述信息更新,OpenAPI 去除了 deprecated 标记,OpenAPI 错误码发生变更
变更项变更内容
API 描述OpenAPI 描述信息更新
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
阿里云首页 云安全中心 相关技术圈