DescribeTagsByResource - 批量查询实例标签--消息队列 RabbitMQ版-火山引擎

文档中心

立即注册

导航

DescribeTagsByResource - 批量查询实例标签

最近更新时间：2024.11.18 10:21:06首次发布时间：2023.05.19 15:47:10

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

使用说明

单次调用该接口最多支持查询 10 个标签。
同一标签键最多支持同时查询 3 个标签值。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeTagsByResource	要执行的操作，取值：DescribeTagsByResource。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
InstanceIds	Array of String	是	["rbtmq-xxxxxx:"]	已绑定标签的实例 ID。支持一次传入多个实例 ID，最多同时传入 50 个实例 ID。
TagFilters	Array of Object	否	[{"Key":"test-key:","Value":"test-val"}]	根据指定标签键值进行过滤，支持根据标签键筛选，或根据标签键+标签值进行筛选。筛选示例请参考根据标签筛选实例。
PageSize	Integer	是	1	查询结果分页展示时，此参数用于表示每页的数据量。取值范围为 1~100。
PageNumber	Integer	是	1	查询结果分页展示时，此参数用于表示页码。支持的最小值为1。

返回参数

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

参数	类型	示例值	描述
Total	Integer	10	符合查询条件的标签总数。
TagResources	Array of Object	[ { "InstanceId": "rbtmq-xxxx", "Key": "test-key", "Value": "test-val", }, ]	标签详情。

请求示例

POST https://rabbitmq.volcengineapi.com/?Action=DescribeTagsByResource&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rabbitmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/rabbitmq/request, SignedHeaders=x-date, Signature=********

{
   "InstanceIds":["rbtmq-xxxxxx:"],
   "TagFilters":[{"Key":"test-key:","Value":"test-val"}],
   "PageNumber":1,
   "PageSize":10,
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230217175421E698024A11179196218F",
        "Action": "DescribeTagsByResource",
        "Version": "2022-01-01",
        "Service": "RabbitMQ",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "ToTal":1
        "TagResource": [
            {
                "InstanceId": "rbtmq-xxxx",
                "Key": "test-key",
                "Value": "test-val",
            },
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后重试。