消息队列 RocketMQ 版批量查询消费组灰度标签列表

1. 接口描述

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

批量查询多个消费组的灰度标签列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeConsumerLabelLists。
Version	是	String	公共参数，本接口取值：2023-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	腾讯云 RocketMQ 实例 ID，从 DescribeFusionInstanceList 接口或控制台获得。示例值：rmq-1****jjdr
Groups.N	是	Array of String	消费组名称列表入参限制：批量上限为 32 条示例值：["grp-123708"]

3. 输出参数

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

4. 示例

示例1 批量查询消费组灰度标签列表成功

输入示例

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

{
    "InstanceId": "rmq-1****jjdr",
    "Groups": [
        "grp-123708"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Results": [
            {
                "Group": "grp-123708",
                "TotalCount": 1,
                "Labels": [
                    {
                        "Label": "de123708",
                        "State": "ACTIVE",
                        "UpdatedAt": 1789631354847
                    }
                ]
            }
        ],
        "RequestId": "72e88f60-568f-4934-bd08-44320ee10e4c"
    }
}

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

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

错误码	描述
FailedOperation	操作失败。

批量查询消费组灰度标签列表

本页目录：