doc-exports/docs/opengauss/api-ref/opengauss_newapi_0006.html

Querying DB Engine Versions

Function

This API is used to query DB engine versions supported by a DB instance. Before calling this API:

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

URI

• URI format

  GET https://{Endpoint}/v3/{project_id}/datastore/versions

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/datastore/versions

• 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.

Request

• Parameter description

  None

• Example Request

  None

Response

• Normal response

  Table 2 dataStores field data structure description

  Name	Type	Description
  versions	Array of Strings	Compatible database versions.

• Example normal response

  {
    "versions": [
      "8.103",
      "3.223",
      "3.222",
      "3.208",
      "3.103",
      "2.7",
      "2.3",
      "1.4",
      "1.0"
    ]
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: DB Engine Versions and Specifications