1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
获取RocketMQ主题列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRocketMQTopics。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Offset | 是 | Integer | 查询偏移量 示例值：0 |
| Limit | 是 | Integer | 查询限制数 示例值：10 |
| ClusterId | 是 | String | 集群ID 示例值：rocketmq-xxxxx |
| NamespaceId | 是 | String | 命名空间 示例值：prod |
| FilterType.N | 否 | Array of String | 按主题类型过滤查询结果，可选择Normal, GlobalOrder, PartitionedOrder, Transaction |
| FilterName | 否 | String | 按主题名称搜索，支持模糊查询 示例值：test |
| FilterGroup | 否 | String | 按订阅消费组名称过滤 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总记录数 示例值：100 |
| Topics | Array of RocketMQTopic | 主题信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取主题列表
输入示例
https://tdmq.tencentcloudapi.com/?
Action=DescribeRocketMQTopics
&Offset=0
&Limit=10
&ClusterId=rocketmq-2p9vx3ax9jxg
&NamespaceId=example
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "c017c4d1-13cb-4f14-ab89-2c6530892f90",
"TotalCount": 1,
"Topics": [
{
"Name": "example-topic",
"Type": "Normal",
"GroupNum": 0,
"Remark": "modified",
"PartitionNum": 3,
"CreateTime": 1621308465000,
"UpdateTime": 1621308657000
}
]
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.IllegalMessage | 内部错误。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.BrokerCluster | 服务的集群不存在。 |
| ResourceNotFound.Cluster | 集群不存在。 |
| ResourceUnavailable | 资源不可用。 |