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

1. 接口描述

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

查询 RocketMQ 5.x 集群信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstance。
Version	是	String	公共参数，本接口取值：2023-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	腾讯云 RocketMQ 实例 ID，从 DescribeInstanceList 接口或控制台获得。示例值：rmq-72mo3a9o

3. 输出参数

参数名称	类型	描述
InstanceType	String	实例类型， EXPERIMENT 体验版 BASIC 基础版 PRO 专业版 PLATINUM 铂金版示例值：EXPERIMENT
InstanceId	String	实例ID 示例值：rmq-72mo3a9o
InstanceName	String	实例名称示例值：test_instance
TopicNum	Integer	主题数量示例值：2
TopicNumLimit	Integer	实例最大主题数量示例值：50
GroupNum	Integer	消费组数量示例值：10
GroupNumLimit	Integer	实例最大消费组数量示例值：500
MessageRetention	Integer	消息保留时间，小时为单位示例值：72
RetentionUpperLimit	Integer	最大可调整消息保留时间，小时为单位示例值：168
RetentionLowerLimit	Integer	最小可调整消息保留时间，小时为单位示例值：1
TpsLimit	Integer	TPS限流值示例值：500
ScaledTpsLimit	Integer	弹性TPS限流值示例值：0
MaxMessageDelay	Integer	延迟消息最长时间，小时为单位示例值：168
CreatedTime	Integer	创建时间，Unix时间戳（毫秒）示例值：1695803467000
SendReceiveRatio	Float	消息发送接收比例示例值：0.5
TagList	Array of Tag	标签注意：此字段可能返回 null，表示取不到有效值。
EndpointList	Array of Endpoint	接入点列表注意：此字段可能返回 null，表示取不到有效值。
TopicQueueNumUpperLimit	Integer	主题队列数上限示例值：32
TopicQueueNumLowerLimit	Integer	主题队列数下限示例值：1
Remark	String	备注信息示例值：测试集群
InstanceStatus	String	实例状态，枚举值如下： - RUNNING：运行中 - ABNORMAL：异常 - OVERDUE：隔离中 - DESTROYED：已销毁 - CREATING：创建中 - MODIFYING：变配中 - CREATE_FAILURE：创建失败 - MODIFY_FAILURE：变配失败 - DELETING：删除中示例值：RUNNING
SkuCode	String	实例规格示例值：experiment_500
PayMode	String	计费模式，枚举值如下： - POSTPAID：后付费按量计费 - PREPAID：预付费包年包月示例值：POSTPAID
ScaledTpsEnabled	Boolean	是否开启弹性TPS 示例值：false
RenewFlag	Integer	预付费集群是否自动续费，枚举值如下： - 0: 不自动续费 - 1: 自动续费示例值：1
ExpiryTime	Integer	到期时间，Unix时间戳（毫秒）示例值：1695803467000
RoleNumLimit	Integer	角色数量限制示例值：10
AclEnabled	Boolean	是否开启 ACL 注意：此字段可能返回 null，表示取不到有效值。示例值：true
TopicNumLowerLimit	Integer	topic个数免费额度注意：此字段可能返回 null，表示取不到有效值。示例值：50
TopicNumUpperLimit	Integer	最大可设置的topic个数注意：此字段可能返回 null，表示取不到有效值。示例值：100
ZoneIds	Array of Integer	所属可用区列表，参考 DescribeZones 接口。示例值：[100001,100002]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群信息成功

查询集群信息成功

输入示例

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

{
    "InstanceId": "rmq-72mo3a9o"
}

输出示例

{
    "Response": {
        "ScaledTpsEnabled": false,
        "InstanceType": "EXPERIMENT",
        "InstanceId": "rmq-72mo3a9o",
        "InstanceName": "test_instance",
        "TopicNum": 2,
        "TopicNumLimit": 50,
        "GroupNum": 10,
        "GroupNumLimit": 500,
        "MessageRetention": 72,
        "RetentionUpperLimit": 168,
        "RetentionLowerLimit": 1,
        "TpsLimit": 500,
        "ScaledTpsLimit": 0,
        "MaxMessageDelay": 168,
        "CreatedTime": 1731920303801,
        "SendReceiveRatio": 0.5,
        "TagList": [
            {
                "TagKey": "test_tag_key",
                "TagValue": "test_tag_value"
            }
        ],
        "EndpointList": [
            {
                "Type": "VPC",
                "Status": "OPEN",
                "PayMode": "PREPAID",
                "EndpointUrl": "rmq-72mo3a9o.rocketmq.xx.qcloud.tencenttdmq.com:8080",
                "VpcId": "vpc-be1tvrab",
                "SubnetId": "subnet-i6fjswac",
                "Bandwidth": 0,
                "IpRules": []
            }
        ],
        "TopicQueueNumUpperLimit": 32,
        "TopicQueueNumLowerLimit": 1,
        "Remark": "测试集群",
        "InstanceStatus": "RUNNING",
        "SkuCode": "experiment_500",
        "PayMode": "PREPAID",
        "RequestId": "32759095-0372-4ec0-ae3a-e5a2759fd0ff"
    }
}

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. 错误码

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

错误码	描述
ResourceNotFound.Instance	实例不存在。

查询集群信息

本页目录：