Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ API Version Query/ Querying Version Information of an API
Updated on 2025-08-18 GMT+08:00
View PDF

Querying Version Information of an API

Function

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

URI

GET https://{Endpoint}/{version}

Table 1 Parameter description

Name

Mandatory

Description

version

Yes

API version. It is case-sensitive.

Request Parameters

None

Response Parameters

Table 2 Parameter description

Name

Type

Description

version

Object

API version information.

For details, see Table 3.
Table 3 version field data structure description

Name

Type

Description

id

String

Backup time window. The creation of an automated backup will be triggered during the backup time window.

The time is in the UTC format.

links

Array of objects

API link information.

For details, see Table 4.

NOTE:

If the version is v3 adn v 3.1, the value is [].

status

String

Version status.

  • CURRENT: The version has been released.
  • SUPPORTED: The version is an earlier version, but it is still available.
  • DEPRECATED: The version is a deprecated version, which may be deleted later.

version

String

Subversion information of the API version.

min_version

String

Minimum API version number.

updated

String

Version update time.

The format is yyyy-mm-ddThh:mm:ssZ.

T is the separator between the calendar and the hourly notation of time. Z indicates the UTC.
Table 4 links field data structure description

Name

Type

Description

href

String

API URL. The value is "".

rel

String

The value is self, indicating that URL is a local link.

Example Request

Querying version information of an API

GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3

Example Response

API version information queried.

{
    "version": {
        "id": "v3",
        "links": [],
        "status": "CURRENT",
        "version": "",
        "min_version": "",
        "updated": "2020-06-23T14:45:51Z"
    }
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: API Version Query