SwitchForUpgrade

Last updated: 2018-10-12 16:08:45

PDF

1. API Description

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

This API (SwitchForUpgrade) is used to switch to a new instance. You can initiate the switch if the instance is in "to be switched" status during master instance upgrade.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com.

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 parameter. The value used for this API: SwitchForUpgrade
Version Yes String Common parameter. The value used for this API: 2017-03-20
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID, such as cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page.

3. Output Parameters

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

4. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
CdbError Backend error or process error.
InternalError.DatabaseAccessError Database's internal error.
InvalidParameter Parameter error.
OperationDenied The operation is not allowed.

5. Example

Example 1 Switch to a new instance

Input example

https://cdb.tencentcloudapi.com/?Action=SwitchForUpgrade
&InstanceId=cdb-eb2w7dto
&<Common request parameters>

Output example

{
  "Response": {
    "RequestId": "1a42feb9-82087f71-6a0031ac-699a92a8"
  }
}

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.