Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the instance version upgrade validation task.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeInstanceUpgradeCheckJob. |
| 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. Downgrade is not supported after upgrade. |
| Parameter Name | Type | Description |
|---|---|---|
| ExistUpgradeCheckJob | Boolean | Existence of historic upgrade validation task within 24 hours |
| 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. |
None
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceUpgradeCheckJob
<Common request parameters>
{
"InstanceId": "037c0b3b-1320-11ee-b0c3-6c92bf629868",
"DstMysqlVersion": "8.0"
}
{
"Response": {
"ExistUpgradeCheckJob": true,
"JobId": 145,
"RequestId": "60b5d6cd-aecc-4740-a681-353e645293b4"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 |
| OperationDenied.InstanceTaskStatusError | Abnormal instance task status. |
| ResourceNotFound.CdbInstanceNotFoundError | The instance cannot be found. Please check whether your instance status is normal. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback