Docs

Message Queue for RabbitMQ

Tag management

DescribeTagsByResource - Batch query instance tags

Call the DescribeTagsByResource API to query resources with bound tags.

Instructions

This API supports querying up to 10 tags per call.

Each tag key supports querying up to 3 tag values simultaneously.

Note

Request frequency: This API limits requests to 100 times per second; the per-user request frequency limit is 20 times per second.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.

Action string required Example value: DescribeTagsByResource

Action to perform, value: DescribeTagsByResource.

Version string required Example value: 2022-01-01

API version, value: 2022-01-01.

InstanceIds string[] required Example: ["rbtmq-6033c8a0****"]

Instance IDs bound to tags.

tip

Supports passing multiple instance IDs at once, up to 50 IDs simultaneously.

TagFilters object[] Optional Example value: [{"Key":"test-key:","Value":"test-val"}]

Filter by the specified tag key. Support filtering by tag key alone or by tag key and tag value together.

For filtering examples, see Tag-Based Filtering Example.

Key string required Example value: owner

Tag key.

Value string Optional Example value: zhangsan

The tag value.

PageSize integer required Example: 1

This parameter represents the number of data items per page when displaying paged query results. The value range is 1 to 100.

PageNumber integer required Example: 1

This parameter indicates the page number when displaying paged query results. The minimum supported value is 1.

Response parameters

Only the unique response parameters of this API are listed below. For more details, see response structure.

Total integer Example: 10

Total number of tags matching the query conditions.

TagResources object[] Example value: [ { "InstanceId": "rbtmq-6033c8a0****", "Key": "test-key", "Value": "test-val", }, ]

Tag details.

InstanceId string Example: rbtmq-6033c8a0****

Instance ID.

Value string Example: zhangsan

The tag value.

Key string Example value: owner

Tag key.

Request example

POST /?Action=DescribeTagsByResource&Version=2022-01-01 HTTP/1.1​
Host: rabbitmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260107T101605Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260107/cn-beijing/RabbitMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceIds": [​
    "[\"rbtmq-6033c8a0****\"]"​
  ],​
  "PageSize": 1,​
  "PageNumber": 1​
}​

Response example

{​
  "ResponseMetadata": {​
    "RequestId": "2026010718114925509722718262****",​
    "Action": "DescribeTagsByResource",​
    "Version": "2022-01-01",​
    "Service": "RabbitMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Total": 10,​
    "TagResources": [​
      {​
        "InstanceId": "rbtmq-6033c8a0****",​
        "Value": "zhangsan",​
        "Key": "owner"​
      }​
    ]​
  }​
}​

Error code

Error codesThe following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.

Status code	Error code	Error message	description
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	The current instance state does not allow this operation.
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	Instance does not exist.
500	InternalError	The request failed due to some unknown error, exception or failure.	Internal error, please try again later.

Last updated: 2026.02.06 14:27:45