DescribeSourceClusterGroupList

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

DescribeSourceClusterGroupList

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

1. API Description

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

This API is used to obtain the group list of the source cluster during the smooth migration process.

The Filters field is a query filter that supports the following fields:.
This API is used to query consumer group names with fuzzy search support.
This API is used to check whether the data is Imported.
This api is used to check the import status. See SourceClusterGroupConfig (https://www.tencentcloud.com/document/api/1493/96031?from_cn_redirect=1#SourceClusterGroupConfig) for details.
This API is used to manage namespaces, valid only for 4.x clusters.

This API is used to demonstrate Filters.
[{
"Name": "GroupName",
"Values": ["group-a"]
}]

A maximum of 20 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: DescribeSourceClusterGroupList.
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	Specifies the task ID. it can be obtained from SmoothMigrationTaskItem returned by the api DescribeSmoothMigrationTaskList or from the console.
Limit	No	Integer	Maximum number of queried results. Default value: 20.
Offset	No	Integer	Starting position of the query. Default value: 0.
Filters.N	No	Array of Filter	Filtering condition list. See the description of the API using this parameter for the usage method.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total query count
Groups	Array of SourceClusterGroupConfig	List of consumption group configurations.
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 Source Cluster Consumer Group List

Input Example

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

{
    "Filters": [],
    "Offset": 0,
    "Limit": 10,
    "TaskId": "02f6c31a-9707-4244-8dd3-35ad868ef92a"
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "TotalCount": 10,
        "Groups": [
            {
                "GroupName": "Test",
                "Remark": "remark",
                "Imported": true,
                "Namespace": "",
                "ImportStatus": "Success",
                "ConsumeMessageOrderly": false,
                "FullNamespaceV4": null,
                "GroupNameV4": null,
                "NamespaceV4": null
            }
        ],
        "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