文档首页/ 分布式消息服务Kafka版/ API参考（吉隆坡区域）/ API V2（推荐）/ 标签管理/ 查询实例标签
更新时间：2025-09-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例标签

功能介绍

查询实例标签。

URI

GET /v2/{project_id}/kafka/{instance_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

tags

Array of TagEntity objects

标签列表
表3 TagEntity

参数

参数类型

描述

key

String

参数解释：

标签键。

约束限制：

  • 不能为空。

  • 对于同一个实例，Key值唯一。

  • 长度为1~128个字符（中文也可以输入128个字符）。

  • 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @

  • 不能以_sys_开头。

  • 首尾字符不能为空格。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

标签值。

约束限制：

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

  • 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

GET https://{endpoint}/v2/{project_id}/kafka/{instance_id}/tags

响应示例

状态码：200

查询实例标签成功。

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

状态码

状态码

描述

200

查询实例标签成功。

错误码

请参见错误码。

父主题： 标签管理