文档首页/ 数据接入服务 DIS/ API参考/ API说明/ 标签管理/ 查询指定通道的标签信息
更新时间:2024-10-21 GMT+08:00
分享

查询指定通道的标签信息

功能介绍

该接口用于查询指定通道的标签信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/stream/{stream_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

stream_id

String

通道ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

tags

Array of Tag objects

标签列表。

表4 Tag

参数

参数类型

描述

key

String

键。

  • 不能为空。

  • 对于同一资源键值唯一。

  • 字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

最小长度:1

最大长度:36

value

String

值。

  • 长度不超过43个字符。

  • 字符集:A-Z,a-z , 0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

  • 只能包含数字、字母、中划线“-”、下划线“_”。

最小长度:0

最大长度:43

请求示例

查询指定通道的标签信息。

GET https://{Endpoint}/v2/{project_id}/stream/{stream_id}/tags

响应示例

状态码: 200

通道标签信息响应体。

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

状态码

状态码

描述

200

通道标签信息响应体。

错误码

请参见错误码

相关文档