通过设置搜索条件查询符合条件的资产信息,例如通过资产实例名称、资产实例所属区域等条件搜索指定资产。目前提供分页和NextToken两种方式,推荐NextToken方式。
接口说明
您可以通过资产的实例 ID、实例名称、所属 VPC ID、地域、公网 IP 地址等条件搜索资产,还可以通过设置不同搜索条件之间的逻辑关系搜索符合多个搜索条件的资产。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-sas:DescribeCloudCenterInstances | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionIddeprecated | 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 | long | 否 | 资源目录成员账号主账号 ID。 说明
调用 DescribeMonitorAccounts 接口可以获取该参数。
| 1232428423234**** |
Flags | string | 否 | 资产厂商。多个资产厂商之间使用半角逗号(,)分隔。取值:
| 1,2,3 |
返回参数
示例
正常返回示例
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"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NoPermission | no permission | 无此服务的访问权限。 |
400 | RdCheckNoPermission | Resource directory account verification has no permission. | 资源目录账号校验无权限。 |
403 | NoPermission | caller has no permission | 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。 |
500 | ServerError | ServerError | 服务故障,请稍后重试! |
500 | RdCheckInnerError | Resource directory account service internal error. | 资源目录账号服务内部错误。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-01 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-07-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-12-23 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更 | 查看变更详情 |