Upgrading the Kernel Version of a DB Instance
Function
This API is used to upgrade the kernel version of a DB instance. Before calling this API:
- Learn how to authenticate it.
- Obtain the required region and endpoint.
URI
POST /v3/{project_id}/instances/{instance_id}/db-upgrade
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
| instance_id | Yes | String | Instance ID, which is compliant with the UUID format. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A |
| X-Language | No | String | Definition Request language type. Constraints N/A Range Default Value en-us |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| delay | No | Boolean | Whether the instance will be upgraded with a delay.
|
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| job_id | String | Definition Task ID. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Example Request
Upgrading the minor version of a DB instance immediately
POST https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/db-upgrade
{
"delay" : false
} Example Response
Status code: 200
Success.
{
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
} Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.