DescribeMigratingTopicStats

最后更新时间：2026-01-13 21:52:10

DescribeMigratingTopicStats

最后更新时间： 2026-01-13 21:52:10

1. API Description

Domain name for API request: trocket.intl.tencentcloudapi.com.

This API is used to query real-time data of migration topics.

A maximum of 50 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeMigratingTopicStats.
Version	Yes	String	Common Params. The value used for this API: 2023-03-08.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
TaskId	Yes	String	Task ID. It can be obtained from SmoothMigrationTaskItem returned by the API DescribeSmoothMigrationTaskList or from the console.
TopicName	Yes	String	Topic name. It can be obtained from MigratingTopic returned by the API DescribeMigratingTopicList in Data Type.
Namespace	No	String	Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from MigratingTopic returned by the API DescribeMigratingTopicList in Data Type.

3. Output Parameters

Parameter Name	Type	Description
SourceClusterConsumerCount	Integer	Number of consumers in the source cluster.
TargetClusterConsumerCount	Integer	Number of consumers in the target cluster.
SourceClusterConsumerGroups	Array of String	Source cluster consumer group list.
TargetClusterConsumerGroups	Array of String	Target cluster consumer group list.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying Real-Time Data of Migration Topics

Input Example

POST / HTTP/1.1
Host: trocket.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigratingTopicStats
<Common request parameters>

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

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
ResourceNotFound.Instance	The instance does not exist.
ResourceNotFound.MigrationTask	Migration task does not exist. Please check and try again.
ResourceNotFound.Topic	Topic does not exist. Please check and try again.
ResourceUnavailable	Resources are unavailable.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud