Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ DB Engine Version Queries/ Querying Version Information About a DB Engine
Updated on 2024-09-11 GMT+08:00

Querying Version Information About a DB Engine

Function

This API is used to query the version information of a specified DB engine. Before calling this API:

URI

GET /v3/{project_id}/datastores/{database_name}

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.

database_name

Yes

String

DB engine. Its value is case-insensitive and can be:

gaussdb-mysql.

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

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

datastores

Array of MysqlEngineVersionInfo objects

DB versions.

Table 4 MysqlEngineVersionInfo

Parameter

Type

Description

id

String

DB version ID. Its value is unique.

name

String

DB version number. Only the major version number with two digits is returned.

version

String

Compatible open-source DB version. A three-number open-source version is returned.

kernel_version

String

DB kernel version. A complete four-number version is returned.

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 version information about a GaussDB(for MySQL) instance

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql

Example Response

Status code: 200

Success.

{
  "datastores" : [ {
    "id" : "87620726-6802-46c0-9028-a8785e1f1921",
    "name" : "8.0",
    "version" : "8.0.22",
    "kernel_version" : "2.0.28.18"
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.