查询 RocketMQ 专享和通用集群列表

1. 接口描述

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

查询 RocketMQ 4.x 集群列表。
当前 API 适用集群：4.x 专享集群和 4.x 通用集群。查询 5.x 集群列表接口文档见 DescribeInstanceList，或者使用 DescribeFusionInstanceList 接口适用所有集群类型。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRocketMQVipInstances。
Version	是	String	公共参数，本接口取值：2020-02-17。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	查询条件过滤器，支持的查询条件如下： instanceIds - 实例ID instanceName - 实例名称 status - 实例状态
Limit	否	Integer	查询数目上限，默认20 示例值：20
Offset	否	Integer	查询起始位置示例值：1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	未分页的总数目示例值：10
Instances	Array of RocketMQVipInstance	实例信息列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例列表

获取实例列表

输入示例

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

{
    "Limit": 20,
    "Offset": 0
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "23ca1a58-0388-4d2d-8465-653a53addda7",
        "Instances": [
            {
                "Status": 1,
                "PayMode": 1,
                "Remark": "remark-info",
                "AutoRenewFlag": 1,
                "InstanceId": "rocketmq-vvqb9emabapx",
                "NodeCount": 3,
                "ExpireTime": 1730877758000,
                "InstanceVersion": "4.9.3",
                "MaxStorage": 200,
                "MaxBandWidth": 10,
                "SpecName": "rocket-vip-basic-1",
                "ConfigDisplay": "基础型",
                "InstanceName": "order-instance",
                "MaxTps": 4000,
                "AclEnabled": true,
                "Retention": 72,
                "MinRetention": 72,
                "MaxRetention": 960
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。