Domain name for API request: tdmq.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.
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 | No | String | Common Params. This parameter is not required for this API. |
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 | |
SortOrder | No | String |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Returned number of vhosts |
VirtualHostList | Array of RabbitMQVirtualHostInfo | List of vhost details |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the list of TDMQ for RabbitMQ vhosts.
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRabbitMQVhost
<Common request parameters>
{
"InstanceId": "amqp-44w9928j"
}
{
"Response": {
"RequestId": "dsfsdfs",
"VirtualHostList": [
{
"InstanceId": "amqp-xxx",
"VirtualHost": "testVhost",
"Description": "hello",
"Tags": [
"shop"
]
}
],
"TotalCount": 1
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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?