API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心

查询RabbitMQ vhost列表

最近更新时间：2024-03-12 01:53:43

我的收藏

本页目录：

1. 接口描述

接口请求域名： tdmq.tencentcloudapi.com 。

查询RabbitMQ vhost列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRabbitMQVirtualHost。
Version 是 String 公共参数，本接口取值：2020-02-17。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。
InstanceId 是 String 集群实例Id
示例值：amqp-xxx
VirtualHost 否 String vhost名,不传则查询全部
示例值：testVhost
Offset 否 Integer 分页Offset
示例值：0
Limit 否 Integer 分页Limit
示例值：20
Filters 否 Filter search-virtual-host：vhost名称模糊查询，之前前缀和后缀匹配
示例值：查询条件
SortElement 否 String 排序依据的字段：
MessageHeapCount - 消息堆积数；
MessageRateInOut - 生产消费速率之和；
MessageRateIn - 生产速率；
MessageRateOut - 消费速率；
示例值：MessageHeapCount
SortOrder 否 String 排序顺序，ascend 或 descend
示例值：ascend

3. 输出参数

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

4. 示例

示例1 查询RabbitMQ vhost列表

-

输入示例

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

{
    "InstanceId": "amqp-44w9928j"
}

输出示例

{
    "Response": {
        "RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "VirtualHostList": [
            {
                "InstanceId": "amqp-xxxxxxxx",
                "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
                },
                "MessageHeapCount": 0,
                "MessageRateIn": 0,
                "MessageRateOut": 0
            },
            {
                "InstanceId": "amqp-xxxxxxxx",
                "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
                },
                "MessageHeapCount": 0,
                "MessageRateIn": 0,
                "MessageRateOut": 0
            }
        ],
        "TotalCount": 2
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
中国站