tencent cloud



Last updated: 2022-08-17 15:58:11

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 primary instance, disaster recovery instance, or read-only instance.

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: UpgradeDBInstanceEngineVersion.
Version Yes String Common Params. The value used for this API: 2017-03-20.
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 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 primary 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.
UpgradeSubversion No Integer Whether to upgrade kernel minor version. Valid values: 1 (upgrade kernel minor version), 0 (upgrade database engine).
MaxDelayTime No Integer Delay threshold. Value range: 1-10

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async task ID. The task execution result can be queried using the async task execution result querying API.
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

&<Common request parameters>

Output Example

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

5. Developer Resources


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.CdbError System error.
InternalError.DatabaseAccessError Internal database error.
InternalError.FtpError File transfer exception
InternalError.TradeError Transaction system error.
InternalError.UndefinedError Unknown error
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.
OperationDenied Operation denied.
OperationDenied.UserHasNoStrategy This account is not authorized to access the requested 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