tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SwitchInstanceVip

Last updated: 2024-04-03 11:32:45

    1. API Description

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

    This API is used to swap the VIPs of instances for instance disaster recovery switch in scenarios where cross-AZ disaster recovery is supported through DTS. After the VIPs of the source and target instances are swapped, the target instance can be written into and the DTS sync task between them will be disconnected.

    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: SwitchInstanceVip.
    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.
    SrcInstanceId Yes String Source instance ID
    DstInstanceId Yes String Target instance ID
    TimeDelay No Integer The time that lapses in seconds since DTS is disconnected between the source instance and the target instance. If the DTS disconnection time period is greater than TimeDelay, the VIP will not be switched. We recommend you set an acceptable value based on the actual business conditions.
    ForceSwitch No Integer Whether to force the switch when DTS is disconnected. 1: yes; 0: no.
    SwitchTime No String now: switch now; syncComplete: switch after sync is completed

    3. Output Parameters

    Parameter Name Type Description
    TaskId Integer Task 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 Sample request

    Input Example

    https://redis.tencentcloudapi.com/?Action=SwitchInstanceVip
&SrcInstanceId=crs-5a4py64p
&DstInstanceId=crs-1kl0iy0v
&ForceSwitch=1
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "9a6bd110-20fc-4e08-b77b-a5656cb6150c",
        "TaskId": 18491
    }
}

    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.DtsStatusAbnormal This operation is not allowed under the current DTS status.
    FailedOperation.SystemError Internal system error, which is irrelevant to the business.
    InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
    InternalError.InternalError Internal error.
    InvalidParameter.InvalidParameter Invalid service parameter.
    InvalidParameterValue.UnSupportedType The instance type is not supported.
    ResourceUnavailable.InstanceStateError Instance status error.
    ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy