tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeReplicationGroup

Last updated: 2024-04-03 11:33:16

    1. API Description

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

    This API is used to query a replication group.

    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: DescribeReplicationGroup.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region No String Common Params. This parameter is not required for this API.
    Limit Yes Integer Number of instances returned per page. Default value: 20.
    Offset Yes Integer Pagination offset, which is an integral multiple of Limit. offset = limit * (page number - 1).
    GroupId No String ID of the specified replication group, such as crs-rpl-m3zt****. Log in to the TencentDB for Redis console, and get it in the global replication group list.
    SearchKey No String Keyword for fuzzy query, which can be a replication group ID or name. Log in to the TencentDB for Redis console, and get them in the global replication group list.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of replication groups
    Groups Array of Groups Replication group information
    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 Sample request

    This example shows you how to query the information of a single replication group.

    Input Example

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

{
    "Limit": 20,
    "GroupId": "crs-rpl-lkgv****",
    "Offset": 0
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "65e950b9-78e8-49b1-9200-0e62a1925557",
        "Groups": [
            {
                "Status": 37,
                "Remark": "Test replication group",
                "InstanceCount": 1,
                "Instances": [
                    {
                        "Engine": "Redis Community Edition",
                        "Vip6": "",
                        "UpdateTime": "2022-11-02 15:04:05",
                        "VpcID": 16770550,
                        "InstanceId": "crs-9c36****",
                        "RedisShardSize": 1024,
                        "RegionId": 1,
                        "RedisShardNum": 1,
                        "Status": 1,
                        "Vip": "10.0.4.42",
                        "DiskSize": 0,
                        "CreateTime": "2022-11-02 15:04:05",
                        "ProductType": 9,
                        "AppId": 0,
                        "Role": "rw",
                        "VPort": 6379,
                        "ZoneId": 1,
                        "InstanceName": "crs-test",
                        "RedisReplicasNum": 1,
                        "GrocerySysId": 1000259
                    }
                ],
                "RegionId": 1,
                "GroupName": "crs-ben-test",
                "AppId": 0,
                "GroupId": "crs-rpl-lkgv****"
            }
        ]
    }
}

    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.
    InvalidParameterValue.ReplicationGroupNotExists The global replication group doesn’t exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy