通过设置搜索条件查询符合条件的资产信息,例如通过资产实例名称、资产实例所属区域等条件搜索指定资产。目前提供分页和NextToken两种方式,推荐NextToken方式。
接口说明
您可以通过资产的实例 ID、实例名称、所属 VPC ID、地域、公网 IP 地址等条件搜索资产,还可以通过设置不同搜索条件之间的逻辑关系搜索符合多个搜索条件的资产。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-sas:DescribeCloudCenterInstances |
get |
*Asset
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId
deprecated
|
string |
否 |
要查询的实例所在地域的 ID。 |
cn-hangzhou |
| Criteria |
string |
否 |
设置搜索资产的条件。该参数 JSON 格式,输入参数时注意大小写。 说明
支持使用资产的实例 ID、实例名称、所属 VPC ID、地域、公网 IP 地址等条件搜索资产。您可以调用 DescribeCriteria 接口查询支持的搜索条件。 |
[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}] |
| MachineTypes |
string |
否 |
要查询的资产的类型。取值:
|
ecs |
| LogicalExp |
string |
否 |
设置多个搜索条件间生效的逻辑关系。默认 OR,取值:
|
OR |
| PageSize |
integer |
否 |
设置分页查询时,每页显示的资产的数量。默认值为 20,表示每页显示 20 条资产信息。 |
100 |
| CurrentPage |
integer |
否 |
设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。 |
1 |
| Importance |
integer |
否 |
设置资产重要性。取值:
|
2 |
| NoGroupTrace |
boolean |
否 |
默认分组未分组是否要做国际化处理。默认 false,取值:
|
false |
| Lang |
string |
否 |
设置请求和接收消息的语言类型,默认为 zh。取值:
|
zh |
| UseNextToken |
boolean |
否 |
是否使用 NextToken 方式拉取资产列表数据。如果使用此参数 TotalCount 不再返回。取值:
|
false |
| NextToken |
string |
否 |
使用 NextToken 方式下返回的 NextToken 值。第一次拉取传空。 |
E17B501887A2D3AA5E8360A6EFA3B*** |
| ResourceDirectoryAccountId |
integer |
否 |
资源目录成员账号主账号 ID。 说明
调用 DescribeMonitorAccounts 接口可以获取该参数。 |
1232428423234**** |
| Flags |
string |
否 |
资产厂商。多个资产厂商之间使用半角逗号(,)分隔。取值:
|
1,2,3 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Success |
boolean |
接口调用的结果状态。取值:
|
true |
| RequestId |
string |
本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
32A73759-4C0F-4801-BE98-901223ACEE9A |
| PageInfo |
object |
页面显示信息。 |
|
| CurrentPage |
integer |
分页查询时,当前页的页码。 |
1 |
| PageSize |
integer |
分页查询时,每页显示的资产的数量。默认值为 20,表示每页显示 20 条资产信息。 |
20 |
| TotalCount |
integer |
查询到的资产的总数量。 |
50 |
| Count |
integer |
当前页显示的资产的条数。 |
10 |
| NextToken |
string |
使用 NextToken 方式下返回的 NextToken 值。 |
B604532DEF982B875E8360A6EFA3B*** |
| Instances |
array<object> |
资产详细信息列表。 |
|
|
object |
资产详细信息。 |
||
| Status |
string |
实例的运行状态。取值:
|
Running |
| CpuInfo |
string |
资产的 CPU 信息。 |
Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz |
| InternetIp |
string |
实例的公网 IP 地址。 |
1.2.XX.XX |
| Kernel |
string |
内核版本信息。 |
3.10.0-1127.19.1.el7.x86_64 |
| Bind |
boolean |
资产是否已绑定授权。取值:
|
true |
| OsName |
string |
实例的内核版本。 |
- |
| Tag |
string |
资产实例的标签名称。 |
InternetIp,test |
| ClientStatus |
string |
实例的客户端在线状态。取值:
|
online |
| Mem |
integer |
内存(MB)。 |
1024 |
| VpcInstanceId |
string |
实例所属 VPC 的 ID。 |
vpc-uf60agqq65bs98zoo**** |
| TagId |
string |
资产的标签 ID。 |
121313,41412 |
| Flag |
integer |
实例是否为阿里云资产。取值:
|
0 |
| LastLoginTimestamp |
integer |
客户端最后上线的时间戳。单位为毫秒。 |
1637592907000 |
| AuthVersion |
integer |
资产的授权版本。取值:
|
1 |
| Region |
string |
实例所属地域 ID。 |
cn-hangzhou-cm***-*** |
| InstanceName |
string |
实例名称。 |
yztest-l*** |
| PodCount |
integer |
容器组个数。 |
1 |
| VulCount |
integer |
实例上存在的漏洞数量。 |
2 |
| HcStatus |
string |
实例是否检测出了基线风险项。取值:
|
YES |
| CreatedTime |
integer |
集群创建的时间戳,单位为毫秒。 |
1607365213000 |
| GroupTrace |
string |
资产所在的分组的名称。 |
default |
| ClusterId |
string |
集群 ID。 |
c690a0789419f4284a4e0a29e12fe**** |
| RiskStatus |
string |
资产是否存在安全风险。取值:
|
NO |
| Cores |
integer |
资产的 CPU 核数。 |
4 |
| VulStatus |
string |
实例是否存在漏洞。取值:
|
YES |
| AlarmStatus |
string |
资产是否存在安全告警。取值:
|
NO |
| MacListString |
string |
系统的 Mac 地址。 |
00:13:3e:31:13:39,02:12:67:b8:**:** |
| Importance |
integer |
资产的重要性。取值:
|
2 |
| HealthCheckCount |
integer |
实例中存在的基线风险数量。 |
1 |
| Ip |
string |
实例的公网 IP 地址。 |
1.2.XX.XX |
| Os |
string |
实例的操作系统。 |
Linux |
| AuthModifyTime |
integer |
资产的授权绑定时间戳。单位:毫秒。 |
1627974044000 |
| SafeEventCount |
integer |
资产存在的安全告警数量。 |
5 |
| InstanceId |
string |
实例 ID。 |
i-m5*** |
| AssetType |
string |
资产的类型。取值:
|
0 |
| IntranetIp |
string |
实例的私网 IP 地址。 |
1.2.XX.XX |
| Vendor |
integer |
资产厂商。取值:
|
0 |
| RegionId |
string |
资产所在的地域的 ID。 |
cn-hanghzou |
| Uuid |
string |
实例的 UUID。 |
c9107c04-942f-40c1-981a-f1c1*** |
| GroupId |
integer |
实例所属分组 ID。 |
4120080 |
| RegionName |
string |
资产的地域名称。 |
China (Hangzhou) |
| VendorName |
string |
资产的服务商名称。 取值:
|
IDC |
| AuthVersionName |
string |
资产的授权版本(具体名称)。取值:
|
Ultimate Edition |
| ClusterName |
string |
集群名称。 |
cluster1 |
| ExposedStatus |
integer |
资产暴露状态。取值:
|
0 |
| RiskCount |
string |
资产存在的风险项统计。JSON 格式,包含以下字段:
|
{ "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 } |
| IpListString |
string |
系统的 IP 列表。 |
172.31.XX.XX,172.171.XX.XX |
| AssetTypeName |
string |
资产的类型名称。 |
Elastic Compute Service |
| FlagName |
string |
资产厂商。取值:
|
ASK |
| AppId |
string |
应用 ID。 说明
该数据仅当 Vendor 为 9 时可存在。 |
test |
| AppName |
string |
应用名称。 说明
该数据仅当 Vendor 为 9 时可存在。 |
testAppName |
| ClientSubStatus |
string |
实例的客户端子状态。取值:
|
online |
| TagResources |
string |
灵骏节点自定义标签,当机器是灵骏机器时才会返回值。 |
app:test,type:lingjun |
| PostPaidFlag |
integer |
当前资产绑定的防护版本计费方式。取值:
|
0 |
| HasContainer |
string |
是否含有容器。取值:
|
YES |
| ServiceId |
string |
服务 ID,仅实例为 Serverless 实例,且归属于 PAI 平台时有值。 |
dsw-76jlywunsif09bp15p |
| VendorUid |
string |
多云实例的账号 ID。 |
123 |
| VendorUserName |
string |
多云实例的账号名称。 |
VendorUserName |
| Namespace |
string |
命名空间。 |
crm-test |
| BindFileProtectType |
string |
是否绑定防篡改授权。取值:
|
block |
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "32A73759-4C0F-4801-BE98-901223ACEE9A",
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 50,
"Count": 10,
"NextToken": "B604532DEF982B875E8360A6EFA3B***"
},
"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",
"AssetTypeName": "Elastic Compute Service",
"FlagName": "ASK",
"AppId": "test",
"AppName": "testAppName",
"ClientSubStatus": "online",
"TagResources": "app:test,type:lingjun",
"PostPaidFlag": 0,
"HasContainer": "YES",
"ServiceId": "dsw-76jlywunsif09bp15p",
"VendorUid": "123",
"VendorUserName": "VendorUserName",
"Namespace": "crm-test",
"BindFileProtectType": "block"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | NoPermission | no permission | |
| 400 | RdCheckNoPermission | Resource directory account verification has no permission. | |
| 500 | ServerError | ServerError | |
| 500 | RdCheckInnerError | Resource directory account service internal error. | |
| 403 | NoPermission | caller has no permission |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。