DescribeMigratingGroupStats

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

DescribeMigratingGroupStats

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

1. API Description

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

This API is used to view real-time information of migration consumption groups.

A maximum of 200 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: DescribeMigratingGroupStats.
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.
GroupName	Yes	String	Specifies the consumer group name. it can be obtained from SourceClusterGroupConfig returned by the api DescribeSourceClusterGroupList or in the console.
Namespace	No	String	Namespace. it is valid only when migrated to 4.x clusters. the namespace can be obtained from SourceClusterGroupConfig returned by the api DescribeSourceClusterGroupList or from the console.

3. Output Parameters

Parameter Name	Type	Description
SourceConsumeLag	Integer	Source cluster consumer group accumulation.
TargetConsumeLag	Integer	Target cluster consumer group accumulation.
SourceConsumerClients	Array of ConsumerClient	Source cluster connection client list.
TargetConsumerClients	Array of ConsumerClient	Target cluster connection client 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 Viewing Real-Time Information of a Migration Consumption Group

Input Example

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

{
    "TaskId": "02f6c31a-9707-4244-8dd3-35ad868ef92a",
    "GroupName": "group-a",
    "Namespace": ""
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "SourceConsumeLag": 0,
        "TargetConsumeLag": 0,
        "SourceConsumerClients": [
            {
                "ClientId": "client-a",
                "ClientAddr": "1.1.1.1",
                "Language": "JAVA",
                "Version": "5",
                "ConsumerLag": 0,
                "ChannelProtocol": ""
            }
        ],
        "TargetConsumerClients": [
            {
                "ClientId": "client-b",
                "ClientAddr": "2.2.2.2",
                "Language": "JAVA",
                "Version": "5.0",
                "ConsumerLag": 0
            }
        ],
        "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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

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

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

是

否

文档反馈

tencent cloud