消息队列 RocketMQ 版查询集群列表

1. 接口描述

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

查询集群列表，支持 4.x 和 5.x 集群，其中 Filters 参数使用说明如下：

InstanceName, 名称模糊查询
InstanceId，集群ID查询
InstanceType, 集群类型查询，支持多选
Version，集群版本查询
当使用TagFilters查询时，Filters参数失效。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFusionInstanceList。
Version	是	String	公共参数，本接口取值：2023-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	否	Integer	查询起始位置示例值：0
Limit	否	Integer	查询结果限制数量示例值：20
Filters.N	否	Array of Filter	查询条件列表
TagFilters.N	否	Array of TagFilter	标签过滤器

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询总数注意：此字段可能返回 null，表示取不到有效值。示例值：10
Data	Array of FusionInstanceItem	实例列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取全量集群列表

输入示例

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

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

输出示例

{
    "Response": {
        "TotalCount": 2,
        "Data": [
            {
                "InstanceId": "rmq-72mo3a9o",
                "InstanceName": "test_instance5x",
                "Version": "5.0",
                "InstanceType": "EXPERIMENT",
                "InstanceStatus": "RUNNING",
                "TopicNumLimit": 52,
                "GroupNumLimit": 520,
                "PayMode": "PREPAID",
                "ExpiryTime": 1731830193435,
                "Remark": "5.X 版本测试集群",
                "TopicNum": 3,
                "GroupNum": 10,
                "TagList": [
                    {
                        "TagKey": "test_tag",
                        "TagValue": "test_tag_key"
                    }
                ],
                "SkuCode": "experiment_500",
                "TpsLimit": 500,
                "ScaledTpsLimit": 0,
                "MessageRetention": 72,
                "MaxMessageDelay": 168,
                "RenewFlag": 1,
                "InstanceItemExtraInfo": {
                    "IsVip": false,
                    "VipInstanceStatus": 0,
                    "MaxBandWidth": 0,
                    "SpecName": "",
                    "NodeCount": 0,
                    "MaxStorage": 0,
                    "MaxRetention": 0,
                    "MinRetention": 0,
                    "InstanceStatus": 0
                },
                "DestroyTime": 0
            },
            {
                "InstanceId": "rocketmq-5kze4gr222mx",
                "InstanceName": "test_instance4x",
                "Version": "4",
                "InstanceType": "BASIC",
                "InstanceStatus": "RUNNING",
                "TopicNumLimit": 400,
                "GroupNumLimit": 4000,
                "PayMode": "PREPAID",
                "ExpiryTime": 1730710586538,
                "Remark": "4.X 版本测试集群",
                "TopicNum": 1,
                "GroupNum": 1,
                "TagList": [
                    {
                        "TagKey": "test_tag",
                        "TagValue": "test_tag_key"
                    }
                ],
                "SkuCode": "",
                "TpsLimit": 8000,
                "ScaledTpsLimit": 0,
                "MessageRetention": 72,
                "MaxMessageDelay": 0,
                "RenewFlag": 1,
                "DestroyTime": 0,
                "InstanceItemExtraInfo": {
                    "IsVip": true,
                    "InstanceStatus": 1,
                    "VipInstanceStatus": 1,
                    "MaxBandWidth": 80,
                    "NodeCount": 2,
                    "MaxStorage": 200,
                    "SpecName": "rocket-vip-basic-0",
                    "MaxRetention": 168,
                    "MinRetention": 24
                }
            }
        ],
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。

查询集群列表

本页目录：