Updated on 2023-11-07 GMT+08:00

Querying the Kernel Version

Function

This API is used to query the kernel version of a DB instance. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/database-version

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.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

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

Value:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

datastore

InstanceDatabaseVersionInfo object

DB version information.

upgrade_flag

Boolean

Whether the version can be upgraded.

  • true: The version can be upgraded.
  • false: The instance cannot be upgraded.
Table 4 InstanceDatabaseVersionInfo

Parameter

Type

Description

current_version

String

Current database version.

current_kernel_version

String

Current database kernel version.

latest_version

String

Latest database version.

latest_kernel_version

String

Latest kernel version.

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

Querying the kernel version of a DB instance

GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/database-version

Example Response

Status code: 200

Success.

{
  "datastore" : {
    "current_version" : "8.0.22",
    "current_kernel_version" : "2.0.28.15",
    "latest_version" : "8.0.22",
    "latest_kernel_version" : "2.0.42.230600"
  },
  "upgrade_flag" : true
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.