文档首页> 资源访问管理 RAM> API参考> API> 标签管理> 根据标签信息查询实例列表
更新时间:2024-03-04 GMT+08:00
分享

根据标签信息查询实例列表

功能介绍

根据标签信息查询资源共享实例列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/resource-shares/resource-instances/filter

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

分页页面的最大值。

最小值:1

最大值:1000

缺省值:1000

offset

String

分页标记。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

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

tags

Array of TagFilter objects

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

数组长度:0 - 20

matches

Array of Match objects

资源共享实例绑定标签列表的匹配字段。

数组长度:0 - 20

表4 TagFilter

参数

是否必选

参数类型

描述

key

String

标签"键"的标识符或名称。

最小长度:1

最大长度:128

values

Array of strings

标签"键"对应的"值"列表。

最小长度:0

最大长度:255

数组长度:0 - 20

表5 Match

参数

是否必选

参数类型

描述

key

String

键。取值范围为policy , organizational-unit, account。

最小长度:0

最大长度:128

value

String

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

最小长度:0

最大长度:255

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

resources

Array of ResourceDTO objects

资源信息列表。

数组长度:0 - 1000

total_count

Integer

总记录数。

表7 ResourceDTO

参数

参数类型

描述

resource_id

String

资源ID。

resource_name

String

资源名称。

tags

Array of Tag objects

资源标签列表。

数组长度:0 - 20

resource_detail

Object

资源详情。

表8 Tag

参数

参数类型

描述

key

String

标签"键"的标识符或名称。

最小长度:1

最大长度:128

value

String

标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。

最小长度:0

最大长度:255

请求示例

根据标签信息查询资源共享实例列表。

POST https://{hostname}/v1/resource-shares/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",
    "resource_detail" : { },
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ]
  } ],
  "total_count" : 0
}

状态码

状态码

描述

200

Successful

错误码

请参见错误码

分享:

    相关文档

    相关产品