tencent cloud

查询RabbitMQ vhost列表

下载
聚焦模式
字号
最后更新时间: 2026-06-24 16:34:10

1. 接口描述

接口请求域名: trabbit.intl.tencentcloudapi.com 。

查询RabbitMQ vhost列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRabbitMQServerlessVirtualHost。
Version String 公共参数,本接口取值:2023-04-18。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 集群实例Id
VirtualHost String vhost名,不传则查询全部
Offset Integer 分页Offset
Limit Integer 分页Limit
Filters Filter search-virtual-host:vhost名称模糊查询,之前前缀和后缀匹配
SortElement String 排序依据的字段:
MessageHeapCount - 消息堆积数;
MessageRateInOut - 生产消费速率之和;
MessageRateIn - 生产速率;
MessageRateOut - 消费速率;
SortOrder String 排序顺序,ascend 或 descend

3. 输出参数

参数名称 类型 描述
TotalCount Integer 返回vhost数量
VirtualHostList Array of RabbitMQVirtualHostInfo vhost详情列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询RabbitMQ vhost列表

输入示例

POST / HTTP/1.1
Host: trabbit.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRabbitMQServerlessVirtualHost
<公共请求参数>

{
    "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
            }
        ]
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidFilter 无效的过滤器
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RegionError 地域错误
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈