tencent cloud

APIs

SubmitInstanceUpgradeCheckJob

Download
Focus Mode
Font Size
Last updated: 2026-06-01 17:02:08

1. API Description

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

This API is used to submit an instance version upgrade validation task.

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: SubmitInstanceUpgradeCheckJob.
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, which can be obtained through the DescribeDBInstances API.
DstMysqlVersion Yes String Target database version.
Description: Available values: 5.6, 5.7, 8.0. Cross-version upgrade is not supported. Version downgrade is unsupported after upgrade.

3. Output Parameters

Parameter Name Type Description
JobId Integer Task ID
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Submit instance upgrade check task

None

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitInstanceUpgradeCheckJob
<Common request parameters>

{
    "InstanceId": "cdb-g3rbtabc",
    "DstMysqlVersion": "8.0"
}

Output Example

{
    "Response": {
        "JobId": 145,
        "RequestId": "a4b54232-d7af-4df3-8329-5110e3ece9c3"
    }
}

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
FailedOperation.FailedOperationError Unsupported operation
InternalError.UnknownError Unknown error
InvalidParameter.ExceptionParam Parameter exception.
OperationDenied.InstanceTaskStatusError Abnormal instance task status.
ResourceNotFound.CdbInstanceNotFoundError The instance cannot be found. Please check whether your instance status is normal.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback