消息队列 Pulsar 版
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 消息队列 Pulsar 版

查询主题列表

最近更新时间：2024-03-12 01:53:48

我的收藏

本页目录：

1. 接口描述

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

获取环境下主题列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTopics。
Version 是 String 公共参数，本接口取值：2020-02-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
EnvironmentId 是 String 环境（命名空间）名称。
示例值：test1
ClusterId 是 String Pulsar 集群的ID
示例值：cluster1
TopicName 否 String 主题名模糊匹配。
示例值：topic1
Offset 否 Integer 起始下标，不填默认为0。
示例值：0
Limit 否 Integer 返回数量，不填则默认为10，最大值为20。
示例值：20
TopicType 否 Integer topic类型描述：
0：非持久非分区主题类型；
1：非持久分区主题类型；
2：持久非分区主题类型；
3：持久分区主题类型；
示例值：1
Filters.N 否 Array of Filter * TopicName
按照主题名字查询，精确查询。
类型：String
必选：否
TopicCreator 否 Integer 创建来源：
1：用户创建
2：系统创建
示例值：1

3. 输出参数

参数名称 类型 描述
TopicSets Array of Topic 主题集合数组。
TotalCount Integer 主题数量。
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取环境下主题列表

获取环境下主题列表

输入示例

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

{
    "EnvironmentId": "abc",
    "TopicName": "abc",
    "Offset": 1,
    "Limit": 1,
    "TopicType": 1,
    "ClusterId": "abc",
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ]
        }
    ],
    "TopicCreator": 1
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "abc",
        "TopicSets": [
            {
                "PulsarTopicType": 0,
                "TopicType": 1,
                "ProducerCount": "abc",
                "ConsumerLimit": "abc",
                "ConsumerCount": "abc",
                "LastLedgerCreatedTimestamp": "14578964532",
                "MsgThroughputIn": "abc",
                "UpdateTime": "2020-09-22 00:00:00",
                "AverageMsgSize": "abc",
                "Partitions": 1,
                "Remark": "abc",
                "LastConfirmedEntry": "abc",
                "TotalSize": "1",
                "NumberOfEntries": "abc",
                "MsgRateOut": "abc",
                "ProducerLimit": "abc",
                "EnvironmentId": "abc",
                "TopicName": "abc",
                "MsgRateIn": "abc",
                "MsgThroughputOut": "abc",
                "SubTopicSets": [
                    {
                        "TopicType": 1,
                        "ProducerCount": "1",
                        "LastConfirmedEntry": "abc",
                        "TotalSize": "1",
                        "NumberOfEntries": "abc",
                        "ConsumerCount": "1",
                        "MsgRateOut": "abc",
                        "AverageMsgSize": "1",
                        "MsgThroughputIn": "abc",
                        "MsgRateIn": "abc",
                        "Partitions": 0,
                        "LastLedgerCreatedTimestamp": "124567885324",
                        "MsgThroughputOut": "abc"
                    }
                ],
                "CreateTime": "2020-09-22 00:00:00"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation CAM鉴权不通过。
FailedOperation 操作失败。
InternalError.SystemError 系统错误。
InvalidParameter.InvalidAdminUrl 无效的管理端接口地址。
InvalidParameterValue.InvalidParams 参数值不在允许范围内。
MissingParameter.NeedMoreParams 必要参数没有传递。
ResourceNotFound.BrokerCluster 服务的集群不存在。
ResourceNotFound.Cluster 集群不存在。
ResourceNotFound.Environment 环境不存在。
中国站