根据资源类型及标签信息查询实例列表 - ListResourceInstances
功能介绍
根据资源类型及标签信息查询实例列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
iam::listResourcesByTagV5 |
List |
- |
|
- |
- |
URI
POST /v5/{resource_type}/resource-instances/filter
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_type |
是 |
String |
资源类型，可以为“信任委托”（trust agency）或“IAM用户”（user）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
分页参数，分页查询记录数。 最小值：1 最大值：1000 缺省值：1000 |
|
offset |
否 |
Integer |
分页参数，偏移量。 从offset指定的下一条数据开始查询。 最小值：0 最大值：5000 缺省值：0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
without_any_tag |
否 |
Boolean |
不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”字段。 该字段为false时查询所有资源，此时“tags”字段生效。 |
|
tags |
否 |
Array of TagsDto objects |
包含标签，最多包含20个key，每个key下面的value最多20个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 数组长度：0 - 20 |
|
matches |
否 |
Array of Match objects |
搜索字段，key为要匹配的字段。 数组长度：0 - 200 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resources |
Array of ResourceDto objects |
ListResourceInstance响应属性 |
|
total_count |
Integer |
总记录数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源ID |
|
resource_detail |
Object |
资源详情。 资源对象，用于扩展。默认为空 |
|
tags |
Array of ResourceTagDto objects |
标签列表，没有标签默认为空数组 |
|
resource_name |
String |
资源名称，资源没有名称时默认为空字符串，eip返回ip地址。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
标签键，可以包含任意语种字母、数字、空格以及"_"、"."、":"、"="、"+"、"-"、"@"符号的任意组合，但是首尾不能包含空格以及不能使用"_sys_"为开头，长度范围[1,128]。 最小长度：1 最大长度：128 |
|
value |
String |
标签值，可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号的任意组合，可以是空字符串，长度范围[0,255]。 最小长度：0 最大长度：255 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
request_id |
String |
请求ID。 |
|
encoded_authorization_message |
String |
加密后的认证失败信息，可以通过STS5解密接口进行解密。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
request_id |
String |
请求ID。 |
状态码：409
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
request_id |
String |
请求ID。 |
请求示例
根据资源类型及标签信息查询实例列表。
POST https://{endpoint}/v5/{resource_type}/resource-instances/filter
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询资源实例列表结果 |
|
400 |
请求体异常。 |
|
403 |
没有操作权限。 |
|
404 |
未找到相应的资源。 |
|
409 |
请求冲突。 |
错误码
请参见错误码。
