tencent cloud

Feedback

SwitchDBInstanceHA

Last updated: 2022-04-20 17:10:06

1. API Description

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

This API is used to start a source-replica switch of instances.

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: SwitchDBInstanceHA.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of tdsql-ow728lmc
Zone Yes String Target AZ. The node with the lowest delay in the target AZ will be automatically promoted to source node.

3. Output Parameters

Parameter Name Type Description
FlowId Integer Async task ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://dcdb.tencentcloudapi.com/?Action=SwitchDBInstanceHA
&InstanceId=tdsql-f35wr6wj
&Zone=ap-guangzhou-1
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "FlowId": 145623
  }
}

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
AuthFailure CAM signature/authentication error
FailedOperation.CreateFlowFailed Failed to create the flow.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetInstanceDetailFailed Failed to get the instance details.
InvalidParameter.InstanceNotFound Failed to find the requested instance.
InvalidParameter.ZoneIdIllegal Incorrect AZ information.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
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