文档首页/ 组织 Organizations/ API参考/ API/ 标签管理/ 根据资源类型及标签信息查询实例列表 - ListResourceInstances
更新时间:2026-07-17 GMT+08:00
分享

根据资源类型及标签信息查询实例列表 - 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

表1 路径参数

参数

是否必选

参数类型

描述

resource_type

String

参数解释

资源类型。枚举值:organizations:policies(服务策略)、organizations:ous(组织OU)、organizations:accounts(账号信息) 、organizations:roots:(根)。

约束限制

必填

取值范围

枚举值:"organizations:policies"、"organizations:ous"、"organizations:accounts"、"organizations:roots"。

默认取值

无默认值

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

页面中最大结果数量。

约束限制

不涉及

取值范围

最小值1、最大值1000。

默认取值

无默认值

offset

String

参数解释

分页标记。

约束限制

必填字段

取值范围

符合正则表达式:[0-9]+

默认取值

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

参数解释

如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

约束限制

不涉及

取值范围

最小长度0、最大长度32768。

默认取值

无默认值

表4 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

参数解释

不包含任意一个标签,该字段为true时查询所有不带标签的资源。

约束限制

取值范围

布尔值:true/false

默认取值

tags

Array of TagsDTO objects

参数解释

包含标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。

约束限制

不涉及

取值范围

最少0个、最多20个。

默认取值

无默认值

matches

Array of Match objects

参数解释

搜索字段,key为要匹配的字段,如organizational-unit等。value为匹配的值。key为固定字典值,不能包含重复的key或不支持的key。

约束限制

取值范围

默认取值

表5 TagsDTO

参数

是否必选

参数类型

描述

key

String

参数解释

键。最大长度127个unicode字符。 key不能为空。

约束限制

必填字段

取值范围

符合正则表达式:^((?!sys|\s)[\p{L}\p{Z}\p{N}.:=+-@]*[\p{L}\p{N}.:=+-@])$

最小长度1、最大长度128。

默认取值

values

Array of strings

参数解释

值列表。每个值最大长度255个unicode字符。

约束限制

必填字段

取值范围

最少0个、最多10个。

默认取值

表6 Match

参数

是否必选

参数类型

描述

key

String

参数解释

键。

约束限制

必填字段

取值范围

默认取值

value

String

参数解释

值。每个值最大长度255个unicode字符。

约束限制

必填字段

取值范围

默认取值

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

resources

Array of ResourceDTO objects

参数解释

资源信息列表。

取值范围

total_count

Integer

参数解释

总记录数。

取值范围

表8 ResourceDTO

参数

参数类型

描述

resource_id

String

参数解释

资源Id。

取值范围

resource_name

String

参数解释

资源名称。

取值范围

tags

Array of Match objects

参数解释

资源标签列表。

取值范围

不涉及

表9 Match

参数

参数类型

描述

key

String

参数解释

键。

取值范围

value

String

参数解释

值。每个值最大长度255个unicode字符。

取值范围

请求示例

根据资源类型及标签信息查询实例列表

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

错误码

请参见错误码

相关文档