更新时间:2023-12-25 GMT+08:00

查询项目标签

功能介绍

查询租户在指定Region和实例类型的所有标签集合。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/{resource_type}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取项目ID请参考 获取项目ID

resource_type

String

资源类型 目前有: smn_topic,主题 smn_sms,短信 smn_application,移动推送

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

tags

Array of ResourceTags objects

资源标签列表。

表4 ResourceTags

参数

参数类型

描述

key

String

键。

  • 最大长度127个unicode字符。

  • key不能为空。

values

Array of strings

值列表。

  • 最多10个value。

  • value不允许重复。

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

  • 如果values为空则表示any_value。

  • value之间为或的关系。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

查询项目标签

GET https://{SMN_Endpoint}/v2/{project_id}/{resource_type}/tags

null

响应示例

状态码: 200

OK

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

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码