文档中心

消息队列 Kafka版

标签管理

DescribeTagsByResource - 查询实例标签

DescribeTagsByResource - 查询实例标签

调用 DescribeTagsByResource 接口查询已绑定标签的资源。

使用说明

单次调用该接口最多支持查询 10 个标签。

同一标签键最多支持同时查询 3 个标签值。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeTagsByResource

要执行的操作，取值：DescribeTagsByResource。

Version string 必选示例值：2022-05-01

API的版本，取值：2022-05-01。

InstanceIds string[] 必选示例值：["kafka-cnng5b3sy14s****"]

已绑定标签的实例 ID。

支持一次传入多个实例 ID，多个 ID 间用英文逗号（,）分隔。最多同时传入 50 个实例 ID。

TagFilters object[] 可选示例值：--

根据指定标签键值进行过滤，支持根据标签键筛选，或根据标签键+标签值进行筛选。

详细示例及说明请参考根据标签筛选实例。

Key string 必选示例值：test-key

标签的键。

Value string 必选示例值：test-val

标签的值。

PageSize integer 必选示例值：10

查询结果分页展示时，此参数用于表示每页的数据量。取值范围为 1~100。

PageNumber integer 必选示例值：1

查询结果分页展示时，此参数用于表示页码。支持的最小值为 1。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Total integer 示例值：10

指定标签对应的的总实例数量。

TagResources object[] 示例值：--

实例的标签信息。

InstanceId string `示例值：kafka-cnai1f0c29ca****

`

实例 ID。

Key string 示例值：key

实例标签的键。

Value string 示例值：value

实例标签的值。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	Forbidden.Authentication	This operation is forbidden by Realname Authentication system.	账户未实名认证。
400	InvalidParameter.Malformed	The specified parameter %s is Malformed.	%s参数不符合规范。
400	InvalidParameter.Unsupported	The specified parameter %s is not supported.	不支持%s参数。
404	InvalidInstance.NotFound	The specified instance does not exist.	该实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。

最近更新时间：2025.08.08 17:47:28

这个页面对您有帮助吗？

有用

有用

无用

无用