文档首页/ 消息通知服务 SMN/ API参考/ API/ 使用标签管理服务/ 查询资源标签
更新时间：2024-09-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询资源标签

功能介绍

查询指定实例的标签信息。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

resource_type

是

String

资源类型

目前有:

smn_topic，主题

smn_sms，短信

smn_application，移动推送

resource_id

是

String

资源ID。

获取resource_id的方法：

当resource_type为“smn_topic”时，

手动添加请求消息头“X-SMN-RESOURCEID-TYPE=name”，资源ID即为topic名称。

不添加请求消息头，通过“查询资源实例”，获取资源ID。

当resource_type为“smn_sms”时，resource_id为签名ID。您可在控制台获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

tags

Array of ResourceTag objects

资源标签列表。
表4 ResourceTag

参数

参数类型

描述

key

String

键，表示要匹配的字段。

当前key的参数值只能取“resource_name”，此时value的参数值为云服务器名称。

  • key不能重复，value为匹配的值。

  • 此字段为固定字典值。

  • 不允许为空字符串。

value

String

值。

当前key的参数值只能取“resource_name”，此时value的参数值为云服务器名称。

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

  • 不可以为空。

状态码： 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}/{resource_id}/tags

null

响应示例

状态码： 200

OK

{
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value3"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。