tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
云数据库 Redis®
    文档
    Download PDF

    AddReplicationInstance

    最后更新时间：2024-12-04 11:19:35
    下载PDF

    1. API Description

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

    This API is used to add an instance member to the global 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: AddReplicationInstance.
    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.
    GroupId Yes String Replication group ID. Log in to the global replication page of the Redis console and obtain it.
    InstanceId Yes String Instance ID. Log in to the Redis console and copy it in the instance list.
    InstanceRole Yes String Assigns roles to instances added to the replication group.
    • rw: read-write;
    • r: read-only.

    3. Output Parameters

    Parameter Name Type Description
    TaskId Integer Asynchronous process ID.
    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 Request Sample

    Input Example

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

{
    "InstanceId": "crs-sa5dsfs",
    "InstanceRole": "rw",
    "GroupId": "crs-rpl-sa5dsfs"
}

    Output Example

    {
    "Response": {
        "RequestId": "c4ed5948-d156-4931-b9c3-10133a0bb6c9",
        "TaskId": 10856
    }
}

    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.
    FailedOperation.UnSupportError The instance does not support this API.
    InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
    InvalidParameterValue.CheckNotPass Business verification failed
    InvalidParameterValue.InstanceNameRuleError A renaming rule error occurred.
    InvalidParameterValue.NotRepeatBind The instance has already been bound.
    InvalidParameterValue.ReplicationGroupNotExists The global replication group doesn’t exist.
    InvalidParameterValue.SpecNotExist The instance specification doesn’t exist.
    InvalidParameterValue.UnSupportedType The instance type is not supported.
    LimitExceeded.ExceedUpperLimit The number of bound instances exceeds the upper limit.
    LimitExceeded.InstanceNotEmpty The bound instance must not be specified.
    LimitExceeded.ReplicationGroupLocked Replication group locked
    ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
    ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
    UnsupportedOperation.LimitProxyVersion The instance version is too low.
    联系我们

    联系我们，为您的业务提供专属服务。

    联系我们
    技术支持

    如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

    提交工单
    7x24 电话支持
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款