Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Upgrading the Kernel Version of a DB Instance
Updated on 2024-09-11 GMT+08:00
View PDF
Share

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:

URI

POST /v3/{project_id}/instances/{instance_id}/db-upgrade

Table 1 URI parameters

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

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

delay

No

Boolean

Whether the instance will be upgraded with a delay.

  • true: The instance will be upgraded during the specified maintenance window.
  • false (default value): The instance will be upgraded immediately.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Task ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

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.

Parent topic: Instance Management