消息队列 Pulsar 版查询生产者客户端列表

1. 接口描述

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

查询 RocketMQ 指定主题下的生产者客户端列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRocketMQProducers。
Version	是	String	公共参数，本接口取值：2020-02-17。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：rocketmq-5kze4gr222mx
NamespaceId	是	String	命名空间示例值：test_ns
Topic	是	String	主题名示例值：test_topic
Offset	是	Integer	分页offset 示例值：0
Limit	是	Integer	分页limit 示例值：20
Filters.N	否	Array of Filter	过滤查询条件列表，支持以下过滤参数： - ClientId：生产者客户端ID - ClientIp：生产者客户端IP

3. 输出参数

参数名称	类型	描述
Producers	Array of ProducerInfo	生产者客户端列表
TotalCount	Integer	总数示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 正常响应

查询生产者客户端列表成功。

输入示例

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

{
    "ClusterId": "rocketmq-5kze4gr222mx",
    "NamespaceId": "test_ns",
    "Topic": "test_topic",
    "Offset": 0,
    "Limit": 0,
    "Filters": [
        {
            "Name": "CliendId",
            "Values": [
                "10.10.10.10@abc"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Producers": [
            {
                "ClientId": "10.10.10.10@abc",
                "ClientIp": "10.10.10.10",
                "Language": "JAVA",
                "Version": "v5_0_5",
                "LastUpdateTimestamp": 1723195366688
            }
        ],
        "TotalCount": 0,
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

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.Instance	实例不存在。
ResourceNotFound.Namspace	命名空间不存在。

查询生产者客户端列表

本页目录：