Ru, Li Yi 11c10554c4 gaussdb_api_1128

Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>

2024-11-28 19:36:20 +00:00

17 KiB

Raw Blame History

Querying Version Information of an API

Function

This API is used to query version information of a specified API. 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}/{version}
Example
https://gaussdb.eu-de.otc.t-systems.com/v3
Parameter description
Table 1 Parameter description
Name

Mandatory

Description

version

Yes

API version. It is case-sensitive.

**Table 1** Parameter description
Name	Mandatory	Description
version	Yes	API version. It is case-sensitive.

Request

None

Response

Normal response

**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. The value is CURRENT, indicating that the version has been released. SUPPORTED: The version is an earlier version, but it is still supported. 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 normal response

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

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: API Version Query

17 KiB Raw Blame History