查询cmq主题详情-API 中心-腾讯云

1. 接口描述

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

查询cmq主题详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCmqTopicDetail。
Version	是	String	公共参数，本接口取值：2020-02-17。
Region	是	String	公共参数，详见产品支持的地域列表。
TopicName	否	String	精确匹配TopicName。示例值：topic-test

3. 输出参数

参数名称	类型	描述
TopicDescribe	CmqTopic	主题详情示例值：{"TopicId":"cmqt-w4nb4z27","TopicName":"rmqbroker-nj","MaxMsgSize":1048576,"FilterType":1,"MsgRetentionSeconds":86400,"Qps":5000,"CreateTime":1692691276000,"LastModifyTime":1692691276000,"MsgCount":0,"CreateUin":null,"Trace":null,"Tags":null,"TenantId":"cmq-13179472","NamespaceName":"CMQ_TOPIC-rmqbroker-nj","Status":1,"BrokerType":1,"SetType":"SHARED","InstanceId":null,"SubscriptionCount":1}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 cmq查询主题详情

输入示例

https://tdmq.tencentcloudapi.com/?Action=DescribeCmqTopicDetail
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "cbeef60c-6525-484a-83e8-6c590e81e749",
        "TopicDescribe": {
            "TopicId": "cmqt-w4nb4z27",
            "TopicName": "rmqbroker-nj",
            "MaxMsgSize": 1048576,
            "FilterType": 1,
            "MsgRetentionSeconds": 86400,
            "Qps": 5000,
            "CreateTime": 1692691276000,
            "LastModifyTime": 1692691276000,
            "MsgCount": 0,
            "CreateUin": null,
            "Trace": null,
            "Tags": null,
            "TenantId": "cmq-1317947242",
            "NamespaceName": "CMQ_TOPIC-rmqbroker-nj",
            "Status": 1,
            "BrokerType": 1,
            "SubscriptionCount": 1
        }
    }
}

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	操作失败。
FailedOperation.CmqBackendError	CMQ 后台服务错误。
ResourceNotFound	资源不存在。
ResourceNotFound.Topic	主题不存在。
ResourceUnavailable	资源不可用。