帮你快速理解、总结文档立即下载

批量查询消费组灰度路由配置

最近更新时间:2026-09-22 02:06:16
我的收藏

1. 接口描述

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

批量查询消费组灰度路由配置

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeConsumerRouteConfigs。
Version 是 String 公共参数,本接口取值:2023-03-08。
Region 是 String 公共参数,详见产品支持的 地域列表。
InstanceId 是 String 腾讯云 RocketMQ 实例 ID,从 DescribeFusionInstanceList 接口或控制台获得。
示例值:rmq-1****jjdr
Configs.N 是 Array of ConsumerRouteKey

批量查询的路由配置列表

入参限制:批量上限为 32 条

3. 输出参数

参数名称 类型 描述
TotalCount Integer 查询总数
示例值:1
Results Array of DescribeConsumerRouteConfigItem

路由配置列表

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量查询消费组灰度路由配置成功示例

输入示例

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

{
    "InstanceId": "rmq-1****jjdr",
    "Configs": [
        {
            "Topic": "tp-fd746f",
            "Group": "grp-fd746f"
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Results": [
            {
                "Key": {
                    "Topic": "tp-fd746f",
                    "Group": "grp-fd746f"
                },
                "Version": 1,
                "Rules": [
                    {
                        "MatchCondition": "grayFlag = '1'",
                        "TargetConsumerLabel": "l1fd746f"
                    }
                ],
                "CutTimestamp": 1789620229459
            }
        ],
        "RequestId": "306632c6-ddbc-409b-9c8e-e246f4f14209"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。