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

使用说明

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

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

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeTagsByResource

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

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceIds string[] 必选示例值：rocketmq-cnai1f0c29ca****,rocketmq-cnai1f0c29ca****

已绑定标签的实例 ID。

支持一次传入多个实例 ID，最多同时传入 50 个实例 ID。

PageNumber integer 必选示例值：1

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

PageSize integer 必选示例值：10

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

TagFilters object[] 可选示例值：[{"Key":"test-key:","Value":"test-val"}]

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

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

Key string 必选示例值：owner

标签的键。

Value string 可选示例值：zhangsan

标签的值。

返回参数

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

Total integer 示例值：10

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

TagResources object[] 示例值：[ { "InstanceId": "rocketmq-cnai1f0c29ca****", "Key": "module", "Value": "tcp" } ]

实例的标签信息。

InstanceId string 示例值：rocketmq-cnai1f0c29ca****

实例 ID。

Key string 示例值：key

实例标签的键。

Value string 示例值：value

实例标签的值。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
400	UnsupportedParameter	The specified parameter %s is unsupported.	不支持%s参数。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	NotModifiedParameter	The resource was not changed.	未变更任何配置。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	MissingParameter	The required Parameter %s is not supplied.	缺少%s参数。
400	InvalidParameter	The specified parameter is not valid: %v.	参数值%s无效。
400	OperationDenied	The operation is not permitted.	不允许该操作。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	当前实例版本不支持指定操作，请升级实例后再试。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定的实例不存在。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	ResourceIsBusy	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

消息队列 RocketMQ版