根据资源类型及标签信息查询实例列表 - ListResourceInstances
功能介绍
根据资源类型及标签信息查询实例列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
organizations:resources:listByTag
List
-
-
-
-
URI
POST /v1/organizations/{resource_type}/resource-instances/filter
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
resource_type | 是 | String | 资源类型。枚举值：organizations:policies（服务策略）、organizations:ous（组织OU）、organizations:accounts（账号信息） 、organizations:roots：（根）。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
limit | 否 | Integer | 页面中最大结果数量。 |
offset | 否 | String | 分页标记。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Security-Token | 否 | String | 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
without_any_tag | 否 | Boolean | 不包含任意一个标签，该字段为true时查询所有不带标签的资源。 |
tags | 否 | Array of TagsDTO objects | 包含标签，最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 |
matches | 否 | Array of Match objects | 搜索字段，key为要匹配的字段，如organizational-unit等。value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
resources | Array of ResourceDTO objects | 资源信息列表。 |
total_count | Integer | 总记录数。 |
参数 | 参数类型 | 描述 |
|---|---|---|
resource_id | String | 资源Id。 |
resource_name | String | 资源名称。 |
tags | Array of Match objects | 资源标签列表。 |
请求示例
根据资源类型及标签信息查询实例列表
POST https://{endpoint}/v1/organizations/{resource_type}/resource-instances/filter
{
"without_any_tag" : true,
"tags" : [ {
"key" : "string",
"values" : [ "string" ]
} ],
"matches" : [ {
"key" : "string",
"value" : "string"
} ]
} 响应示例
状态码：200
Successful
{
"resources" : [ {
"resource_id" : "string",
"resource_name" : "string",
"tags" : [ {
"key" : "string",
"value" : "string"
} ]
} ],
"total_count" : 0
} 状态码
状态码 | 描述 |
|---|---|
200 | Successful |
错误码
请参见错误码。
