tencent cloud



Last updated: 2023-07-05 15:57:40

1. API Description

Domain name for API request: ckafka.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 results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 20.
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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the details of unsynced topic

Input Example

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

    "InstanceId": "xx",
    "TopicName": "xxx",
    "Offset": 0,
    "Limit": 10,
    "OutOfSyncReplicaOnly": true

Output Example

    "Response": {
        "Result": {
            "TotalCount": 1,
            "TopicInSyncReplicaList": [
                    "Partition": "xxxx",
                    "Leader": 1,
                    "Replica": "110,3551,2315",
                    "InSyncReplica": "100,5526",
                    "BeginOffset": 10,
                    "EndOffset": 10,
                    "MessageCount": 1,
                    "OutOfSyncReplica": "120,51"
        "RequestId": "xx"

5. Developer Resources


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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support