UpgradeDBInstanceEngineVersion

Last updated: 2020-03-23 14:59:12

1. API Description

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

This API (UpgradeDBInstanceEngineVersion) is used to upgrade the version of a TencentDB instance, which can be a master instance, disaster recovery instance, or read-only instance.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, 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: UpgradeDBInstanceEngineVersion.
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 in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the instance list querying API to query the ID, whose value is the InstanceId value in output parameters.
EngineVersion Yes String Version of master instance database engine. Value range: 5.6, 5.7
WaitSwitch No Integer Mode of switch to a new instance. Value range: 0 (switch immediately), 1 (switch within a time window). Default value: 0. If the value is 1, the switch process will be performed within a time window. Or, you can call the switching to new instance API to trigger the process.

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String 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 Upgrading the Version of a TencentDB Instance

Input Example

https://cdb.tencentcloudapi.com/?Action=UpgradeDBInstanceEngineVersion
&InstanceId=cdb-8qrg9t04
&EngineVersion=5.7
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "AsyncRequestId": "d2baf2fb-cbae62df-7dd0d736-9cbd3e31"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.StatusConflict Task status conflict.
InternalError.DatabaseAccessError Internal database error.
InternalError.TradeError Transaction system error.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.