DescribeRabbitMQVirtualHost

Last updated: 2025-11-25 10:53:09

DescribeRabbitMQVirtualHost

Last updated: 2025-11-25 10:53:09

1. API Description

Domain name for API request: tdmq.intl.tencentcloudapi.com.

This API is used to query the list of TDMQ for RabbitMQ vhosts.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeRabbitMQVirtualHost.
Version	Yes	String	Common Params. The value used for this API: 2020-02-17.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Cluster instance ID
VirtualHost	No	String	Vhost name. If this parameter is not specified, all will be queried by default.
Offset	No	Integer	Pagination offset
Limit	No	Integer	Pagination limit
Filters	No	Filter	Fuzzy query by vhost name
SortElement	No	String	Specifies the sorting field. MessageHeapCount - specifies the message backlog count. MessageRateInOut - total production and consumption rate. MessageRateIn - production rate. MessageRateOut - consumption rate.
SortOrder	No	String	Sorting order. Valid values: ascend and descend.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Returned number of vhosts
VirtualHostList	Array of RabbitMQVirtualHostInfo	List of vhost details
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 This API is used to query the list of TDMQ for RabbitMQ vhosts.

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRabbitMQVhost
<Common request parameters>

{
    "InstanceId": "amqp-test"
}

Output Example

{
    "Response": {
        "RequestId": "a8f28d5e-a7e2-4b0b-afa0-2fba09c077a0",
        "VirtualHostList": [
            {
                "InstanceId": "amqp-test",
                "VirtualHost": "vhost",
                "Description": "",
                "Tags": [],
                "CreateTime": "2023-07-18 12:55:00.778",
                "ModifyTime": "2023-07-18 12:55:00.778",
                "VirtualHostStatistics": {
                    "CurrentQueues": 1,
                    "CurrentExchanges": 6,
                    "CurrentConnections": 1,
                    "CurrentChannels": 1,
                    "CurrentUsers": 1
                },
                "TraceFlag": true,
                "MessageHeapCount": 0,
                "MessageRateIn": 0,
                "MessageRateOut": 0
            },
            {
                "InstanceId": "amqp-test",
                "VirtualHost": "test2",
                "Description": "",
                "Tags": [],
                "CreateTime": "2023-07-18 12:55:16.230",
                "ModifyTime": "2023-07-18 12:55:19.856",
                "VirtualHostStatistics": {
                    "CurrentQueues": 0,
                    "CurrentExchanges": 0,
                    "CurrentConnections": 0,
                    "CurrentChannels": 0,
                    "CurrentUsers": 0
                },
                "TraceFlag": true,
                "MessageHeapCount": 0,
                "MessageRateIn": 0,
                "MessageRateOut": 0
            }
        ],
        "TotalCount": 2
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InternalError	Internal error.
InvalidParameter	Incorrect parameter.
ResourceNotFound	The resource does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud