文档首页> 全球加速 GA> API参考> API> 标签> 通过标签查询资源实例列表
更新时间：2024-04-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

通过标签查询资源实例列表

功能介绍

通过标签查询资源实例列表。

调用方法

请参见如何调用API。

URI

POST /v1/{resource_type}/resource-instances/filter

表1 路径参数

参数

是否必选

参数类型

描述

resource_type

是

Object

资源类型。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页返回的个数。

最小值：1

最大值：1000

缺省值：1000

offset

否

Integer

偏移量。

最小值：0

缺省值：0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表4 请求Body参数

参数

是否必选

参数类型

描述

tags

否

Array of Tag objects

标签列表。

数组长度：1 - 20

matches

否

Array of Match objects

匹配项列表。

数组长度：1 - 1
表5 Tag

参数

是否必选

参数类型

描述

key

是

String

标签的KEY。

最小长度：1

最大长度：128

values

是

Array of strings

标签的VALUES。

最小长度：0

最大长度：255

数组长度：0 - 10
表6 Match

参数

是否必选

参数类型

描述

key

是

String

匹配的KEY。

枚举值：

  • resource_name

value

是

String

匹配的VALUE。

最小长度：0

最大长度：255

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

resources

Array of ResourceTags objects

资源列表。

total_count

Integer

资源总数量。
表8 ResourceTags

参数

参数类型

描述

resource_id

String

资源ID。

resource_name

String

资源名称。

tags

Array of ResourceTag objects

标签。
表9 ResourceTag

参数

参数类型

描述

key

String

标签键，规则：

  • 1.key不能为空，长度1~128个字符（中文也可以输入128个字符）。

  • 2.可用 UTF-8 格式表示的字母（包含中文）、数字和空格，以及以下字符_ . : = + - @。

  • 3._sys_开头属于系统标签，租户不能输入。

最小长度：1

最大长度：128

value

String

标签值，规则：

  • 1.长度0~255个字符（中文也可以输入255个字符）。

  • 2.可用 UTF-8 格式表示的字母（包含中文）、数字和空格，以及以下字符_ . : / = + - @。

  • 3.资源标签值可以为空（empty or null）。

最小长度：0

最大长度：255

请求示例

通过标签查询资源实例列表

POST https://{ga_endpoint}/v1/{resource_type}/resource-instances/filter

{
  "tags" : [ {
    "key" : "tagKey",
    "values" : [ "tagValue" ]
  } ],
  "matches" : [ {
    "key" : "resourceName",
    "value" : "name"
  } ]
}

响应示例

状态码： 200

操作成功

{
  "resources" : [ {
    "resource_id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7443",
    "resource_name" : "resourceName",
    "tags" : [ {
      "key" : "tagKey",
      "value" : "tagValue"
    } ]
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码。

父主题： 标签
分享：

    相关文档

    相关产品