UpgradeDBInstanceEngineVersion

Last updated: 2024-01-30 10:25:49

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	No	String	Common Params. This parameter is not required for this API.
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	Switch mode for accessing the new instance. Valid values: `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 SwitchForUpgrade 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

This example shows you how to upgrade the version of a TencentDB instance.

Input Example

POST / HTTP/1.1Host: cdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: UpgradeDBInstanceEngineVersion<common request parameters>{    "InstanceId": "cdb-8qrg9t04",    "EngineVersion": "5.7"}

Output Example

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

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

Tencent Cloud CLI 3.0

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.ActionNotSupport	Unsupported operation.
OperationDenied.UserHasNoStrategy	This account is not authorized to access the requested resource.

tencent cloud

Recent Pages