消息队列 Pulsar 版获取RocketMQ主题详情

1. 接口描述

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

获取RocketMQ主题详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRocketMQTopic。
Version	是	String	公共参数，本接口取值：2020-02-17。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：rocketmq-4k4orqgq
NamespaceId	是	String	命名空间示例值：test_ns
TopicName	是	String	主题名称示例值：test_topic
ConsumerGroup	否	String	消费组名称示例值：test_group
Offset	否	Integer	订阅列表分页参数Offset 示例值：0
Limit	否	Integer	订阅列表分页参数Limit 示例值：10

3. 输出参数

参数名称	类型	描述
Topic	RocketMQTopic	Topic详情
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取主题详情

输入示例

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

{
    "ClusterId": "rocketmq-zpz97455xwap",
    "NamespaceId": "namespace",
    "TopicName": "test_topic",
    "ConsumerGroup": ""
}

输出示例

{
    "Response": {
        "RequestId": "121e5b17-7e8b-4849-b168-c02b67ebfbba",
        "Topic": {
            "Name": "test_topic",
            "Type": "Normal",
            "GroupNum": 0,
            "Remark": null,
            "PartitionNum": 3,
            "CreateTime": 1696662165000,
            "UpdateTime": 1696662165000,
            "InstanceId": "rocketmq-zpz97455xwap",
            "Namespace": "namespace",
            "LastUpdateTime": 1696751238307,
            "SubscriptionCount": 1,
            "SubscriptionData": [
                {
                    "Topic": "test_topic",
                    "Type": null,
                    "PartitionNum": null,
                    "ExpressionType": "TAG",
                    "SubString": "msgTag",
                    "Status": null,
                    "ConsumerLag": 0,
                    "ClusterId": "rocketmq-zpz97455xwap",
                    "ConsumerGroup": "test_group",
                    "IsOnline": true,
                    "ConsumeType": 0,
                    "Consistency": 0,
                    "LastUpdateTime": 1696751238307,
                    "MaxRetryTimes": 16
                }
            ]
        }
    }
}

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

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

错误码	描述
ResourceNotFound.Cluster	集群不存在。
ResourceNotFound.Topic	主题不存在。