tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeReplicationGroupInstance

Last updated: 2024-12-04 11:20:14

1. API Description

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

This API is used to query replication group information.

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: DescribeReplicationGroupInstance.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Specifies the instance ID. Example: crs-xjhsdj****. Log in to the TencentDB for Redis console and copy the instance ID in the instance list.

3. Output Parameters

Parameter Name Type Description
AppId Integer AppID。
RegionId Integer Numerical code of a region.
GroupId String String ID of a replication group.
GroupName String Replication group name.
InstanceRole String Instance replication group role.
- r: secondary instance.
- rw: primary instance.
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 Replication Group Information

This example shows you how to query the replication group information of an instance.

Input Example

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

{
    "InstanceId": "crs-a7oxxxxx"
}

Output Example

{
    "Response": {
        "AppId": 251237400,
        "GroupId": "crs-rpl-oxsincth",
        "GroupName": "test",
        "InstanceRole": "rw",
        "RegionId": 1,
        "RequestId": "02ef9326-3db7-47ab-8f65-c6d1a772f71c"
    }
}

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.SystemError Internal system error, which is irrelevant to the business.
InternalError.CamAuthOssResponseReturnCodeError A CAM authentication error occurred.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
InvalidParameter.InvalidParameter Invalid service parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy