文档首页/ 配置审计 Config/ API参考/ API/ 资源标签/ 查询项目标签
更新时间：2024-09-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询项目标签

功能介绍

查询租户在指定Project中实例类型的所有资源标签集合。标签管理服务需要能够列出当前租户全部已使用的资源标签集合，为各服务Console打资源标签和过滤实例时提供标签联想功能。

调用方法

请参见如何调用API。

URI

GET /v1/resource-manager/{resource_type}/tags

表1 路径参数

参数

是否必选

参数类型

描述

resource_type

是

String

资源类型
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

查询记录数默认为1000，limit最多为1000,不能为负数，最小值为1

最小值：1

最大值：1000

缺省值：1000

offset

否

Integer

索引位置，从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）,必须为数字，不能为负数

最小值：0

缺省值：0

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

tags

Array of Tag objects

标签列表

total_count

Integer

总记录数
表4 Tag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做字符集校验)，key不能为空或者空字符串，不能为空格，校验和使用之前先trim 前后半角空格。

最小长度：1

最大长度：128

values

Array of strings

值列表。每个值最大长度255个unicode字符，校验和使用之前先trim 前后半角空格。value可为空数组但不可缺省。如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系。(搜索时不对此参数做字符集校验，只做长度校验)

最大长度：255

数组长度：0 - 20

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

查询租户实例类型的所有资源标签集合

GET https://{endpoint}/v1/resource-manager/{resource_type}/tags

响应示例

状态码： 200

操作成功。

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value1", "value2" ]
  } ],
  "total_count" : 1001
}

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

401

鉴权失败。

403

用户身份认证失败。

404

资源未找到

500

服务器内部错误。

错误码

请参见错误码。

父主题： 资源标签

相关文档