tencent cloud

DescribeTopicSyncReplica
最后更新时间：2025-11-21 20:32:23
DescribeTopicSyncReplica
最后更新时间： 2025-11-21 20:32:23

1. API Description

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

This API is used to get the details of a synced topic replica.

A maximum of 5 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: DescribeTopicSyncReplica.
Version Yes String Common Params. The value used for this API: 2019-08-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
TopicName Yes String Topic name
Offset No Integer Offset. If this parameter is left empty, 0 will be used by default.
Limit No Integer Number of returned results. default value: 20. must be greater than 0.
OutOfSyncReplicaOnly No Boolean Filters unsynced replicas only

3. Output Parameters

Parameter Name Type Description
Result TopicInSyncReplicaResult Returns topic replica details
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 Topic Synchronization Details

Input Example

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

{
    "InstanceId": "ckafka-test",
    "TopicName": "topic-test",
    "Offset": 1,
    "Limit": 0,
    "OutOfSyncReplicaOnly": true
}

Output Example

{
    "Response": {
        "RequestId": "3faffeb7-6e6b-4689-8a00-4d5e5f9e9f22",
        "Result": {
            "TopicInSyncReplicaList": [
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150032,150033",
                    "Leader": 150032,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-0",
                    "Replica": "150032,150033"
                },
                {
                    "BeginOffset": 1,
                    "EndOffset": 3,
                    "InSyncReplica": "150033,150034",
                    "Leader": 150033,
                    "MessageCount": 2,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-1",
                    "Replica": "150033,150034"
                },
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150034,150035",
                    "Leader": 150034,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-2",
                    "Replica": "150034,150035"
                },
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150035,150032",
                    "Leader": 150035,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-3",
                    "Replica": "150035,150032"
                },
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150032,150033",
                    "Leader": 150032,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-4",
                    "Replica": "150032,150033"
                },
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150033,150034",
                    "Leader": 150033,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-5",
                    "Replica": "150033,150034"
                },
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150034,150035",
                    "Leader": 150034,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-6",
                    "Replica": "150034,150035"
                },
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150035,150032",
                    "Leader": 150035,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-7",
                    "Replica": "150035,150032"
                },
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150032,150033",
                    "Leader": 150032,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-8",
                    "Replica": "150032,150033"
                },
                {
                    "BeginOffset": 0,
                    "EndOffset": 0,
                    "InSyncReplica": "150033,150034",
                    "Leader": 150033,
                    "MessageCount": 0,
                    "OutOfSyncReplica": "",
                    "Partition": "partition-9",
                    "Replica": "150033,150034"
                }
            ],
            "TotalCount": 10
        }
    }
}

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

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InstanceNotExist The instance does not exist.
UnsupportedOperation Unsupported operation.
本页内容是否解决了您的问题？
您也可以 联系销售 或 提交工单 以寻求帮助。
是
否

文档反馈