doc-exports/docs/gaussdb_mysql/api-ref/gaussdb_11_0001.html

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:

• Learn how to authorize and authenticate it.
• Obtain the required region and endpoint.

URI

• URI format

  GET https://{endpoint}/mysql/v3/{project_id}/datastores/{database_name}

• Example

  GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
  database_name	Yes	DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.
Content-Type	Yes	String	MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

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.

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

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql

Example Response

Status code: 200

Success.

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

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: APIs (Unavailable Soon)