消息队列 RocketMQ 版查询迁移主题的实时数据

1. 接口描述

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

用于查询迁移主题的实时数据

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMigratingTopicStats。
Version	是	String	公共参数，本接口取值：2023-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
TaskId	是	String	任务ID，可在DescribeSmoothMigrationTaskList接口返回的SmoothMigrationTaskItem或控制台中获得。示例值：4f9864ae-26ac-4662-9ede-1942b20d7a04
TopicName	是	String	主题名称，可在DescribeMigratingTopicList接口返回的MigratingTopic数据结构中获得。示例值：topic-a
Namespace	否	String	命名空间，仅迁移至4.x集群有效，可在DescribeMigratingTopicList接口返回的MigratingTopic数据结构中获得。示例值：tdmq-default

3. 输出参数

参数名称	类型	描述
SourceClusterConsumerCount	Integer	源集群的消费者数量示例值：1
TargetClusterConsumerCount	Integer	目标集群的消费者数量示例值：1
SourceClusterConsumerGroups	Array of String	源集群消费组列表示例值：["Group-A"]
TargetClusterConsumerGroups	Array of String	目标集群消费组列表示例值：["GROUP_B"]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询迁移主题实时数据

输入示例

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

{
    "TaskId": "02f6c31a-9707-4244-8dd3-35ad868ef92a",
    "TopicName": "TopicTest",
    "Namespace": ""
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "SourceClusterConsumerCount": 0,
        "TargetClusterConsumerCount": 0,
        "SourceClusterConsumerGroups": [],
        "TargetClusterConsumerGroups": [],
        "RequestId": "02f6c31a-9707-4244-8dd3-35ad868ef92a"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
ResourceNotFound.Instance	实例不存在。
ResourceNotFound.MigrationTask	迁移任务不存在，请检查后重试。
ResourceNotFound.Topic	主题不存在，请检查后重试。
ResourceUnavailable	资源不可用。

查询迁移主题的实时数据

本页目录：