# 根据资源类型及标签信息查询实例列表 - ListResourceInstances #### 功能介绍 根据资源类型及标签信息查询实例列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Organizations/doc?api=ListResourceInstances)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-organizations/org_04_0030.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | 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"。 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 页面中最大结果数量，单位：条。 **约束限制**： 不涉及 **取值范围**： 最小值1、最大值1000。 **默认取值**： 不涉及 | | offset | 否 | String | **参数解释**： 分页标记，用于指定从上一次响应中获取的偏移量，以查询下一页数据。 **约束限制**： 不涉及 **取值范围**： 符合正则表达式：\[0-9\]+。最小长度1、最大长度20。 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Security-Token | 否 | String | **参数解释**： 如果正在使用临时安全凭据，则此 header 是必需的，该值是临时安全凭据的安全令牌（会话令牌）。通过IAM服务的获取临时访问密钥接口获取临时安全凭据。 **约束限制**： 不涉及 **取值范围**： 不涉及字符类型限制。 最小长度0、最大长度32768。 **默认取值**： 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | without_any_tag | 否 | Boolean | **参数解释**： 不包含任意一个标签，该字段为true时查询所有不带标签的资源。 **约束限制**： 无 **取值范围**： 布尔值：true：查询所有不带标签的资源；false：不查询所有不带标签的资源。 **默认取值**： 不涉及 | | tags | 否 | Array of [TagsDTO] objects | **参数解释**： 包含标签，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。数组内元素为TagsDTO对象，包含标签键key和值列表values。 **约束限制**： 最少0个、最多20个。 **默认取值**： 不涉及 | | matches | 否 | Array of [Match] objects | **参数解释**： 搜索字段，key为要匹配的字段，支持organizational-unit、account、root。value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。数组内元素为Match对象，包含匹配字段键key和值value。 **约束限制**： 最少0个、最多200个。 **默认取值**： 不涉及 | 表5TagsDTO | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释**： 标签键，用于标识标签的键名。最大长度128个unicode字符。 **约束限制**： key不能为空。 **取值范围**： 符合正则表达式：\^((?!*sys* \|\\s)\[\\p{L}\\p{Z}\\p{N}*.:=+-@\]\*\[\\p{L}\\p{N}*.:=+-@\])$ 最小长度1、最大长度128。 **默认取值**： 不涉及 | | values | 是 | Array of strings | **参数解释**： 标签值列表，用于指定标签键对应的标签值，数组内元素为string类型，表示单个标签值。每个值最大长度255个unicode字符。 **约束限制**： 最少0个、最多10个。 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表6Match | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释**： 搜索字段名称或标签键。作为搜索字段名称时，用于指定要匹配的资源字段类型，支持的字段包括organizational-unit（组织单元）、account（账号）、root（根）；作为标签键时，用于标识资源标签的键名。 **约束限制**： 不涉及 **取值范围**： 搜索字段名称时：organizational-unit、account、root。标签键时：无限制。 **默认取值**： 不涉及 | | value | 是 | String | **参数解释**： 搜索匹配字段的值或标签值。作为搜索字段值时，用于资源搜索时的字段值匹配，每个值最大长度256个unicode字符；作为标签值时，用于标识资源标签的值。 **约束限制**： 不涉及 **取值范围**： 无 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resources | Array of [ResourceDTO] objects | **参数解释**： 资源信息列表。数组内元素为ResourceDTO对象，包含资源id、资源名称及标签等详细信息。 | | total_count | Integer | **参数解释**： 总记录数。 **取值范围**： 无 | 表8ResourceDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_id | String | **参数解释**： 资源Id。 **取值范围**： 无 | | resource_name | String | **参数解释**： 资源名称。 **取值范围**： 无 | | tags | Array of [Match] objects | **参数解释**： 资源标签列表。数组内元素为Match对象，包含标签键key和值value。 | 表9Match | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 搜索字段名称或标签键。作为搜索字段名称时，用于指定要匹配的资源字段类型，支持的字段包括organizational-unit（组织单元）、account（账号）、root（根）；作为标签键时，用于标识资源标签的键名。 **取值范围**： 搜索字段名称时：organizational-unit、account、root。标签键时：无限制。 | | value | String | **参数解释**： 搜索匹配字段的值或标签值。作为搜索字段值时，用于资源搜索时的字段值匹配，每个值最大长度256个unicode字符；作为标签值时，用于标识资源标签的值。 **取值范围**： 无 | #### 请求示例 根据资源类型及标签信息查询实例列表 ``` POST https://{endpoint}/v1/organizations/{resource_type}/resource-instances/filter { "without_any_tag" : true, "tags" : [ { "key" : "environment", "values" : [ "production" ] } ], "matches" : [ { "key" : "account", "value" : "0a6d25d23900d45c0faac010e0fb4de0" } ] } ``` #### 响应示例 **状态码：200** Successful ``` { "resources" : [ { "resource_id" : "string", "resource_name" : "string", "tags" : [ { "key" : "string", "value" : "string" } ] } ], "total_count" : 0 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Successful | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-organizations/ErrorCode.html)。