Domain name for API request: trabbit.intl.tencentcloudapi.com.
This API is used to query a RabbitMQ vhost list.
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: DescribeRabbitMQServerlessVirtualHost. |
| Version | Yes | String | Common Params. The value used for this API: 2023-04-18. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | instance ID |
| VirtualHost | No | String | Specifies the vhost name. if it is not provided, query all. |
| Offset | No | Integer | Pagination offset |
| Limit | No | Integer | Pagination limit |
| Filters | No | Filter | search-virtual-host: specifies fuzzy name search of vhost names. earlier, it supported both prefix and suffix matching. |
| SortElement | No | String | Sorting field. MessageHeapCount specifies the number of message backlogs. MessageRateInOut specifies the total production and consumption rate. MessageRateIn specifies the production rate. MessageRateOut specifies the consumption rate. |
| SortOrder | No | String | Sort order. valid values: ascend or descend. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Return the number of vhosts. |
| VirtualHostList | Array of RabbitMQVirtualHostInfo | Specifies the list of details of the vhost. |
| 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. |
POST / HTTP/1.1
Host: trabbit.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRabbitMQServerlessVirtualHost
<Common request parameters>
{
"InstanceId": "amqp-44w9928j"
}{
"Response": {
"RequestId": "dc0de4d7-31c0-47ca-8142-d803d704a44b",
"TotalCount": 2,
"VirtualHostList": [
{
"InstanceId": "ramqp-cpssyrct",
"VirtualHost": "testVhost",
"Description": "default vhost",
"Tags": [],
"CreateTime": "2024-10-14 20:06:40:000",
"ModifyTime": "2024-10-14 20:06:40:000",
"VirtualHostStatistics": {
"CurrentQueues": 0,
"CurrentExchanges": 0,
"CurrentConnections": 0,
"CurrentChannels": 0,
"CurrentUsers": 0
},
"Status": "running",
"MessageHeapCount": 0,
"MessageRateIn": 0,
"MessageRateOut": 0,
"MirrorQueuePolicyFlag": false
},
{
"InstanceId": "ramqp-cpssyrct",
"VirtualHost": "ledou-test",
"Description": "",
"Tags": [],
"CreateTime": "2024-10-16 14:38:58:000",
"ModifyTime": "2024-10-16 14:38:58:000",
"VirtualHostStatistics": {
"CurrentQueues": 0,
"CurrentExchanges": 0,
"CurrentConnections": 0,
"CurrentChannels": 0,
"CurrentUsers": 0
},
"Status": "running",
"MessageHeapCount": 0,
"MessageRateIn": 0,
"MessageRateOut": 0,
"MirrorQueuePolicyFlag": false
}
]
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| DryRunOperation | DryRun operation means the request will be successful, but the DryRun parameter is passed. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidFilter | Invalid Filter |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Parameters are missing |
| OperationDenied | Operation denied. |
| RegionError | Region error. |
| RequestLimitExceeded | Request limit exceeded. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | Resources are unavailable. |
| ResourcesSoldOut | Resources are sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
フィードバック