Dong, Qiu Jian 3336ba8df7 CCE API for v1.23

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>

2022-11-10 12:48:59 +00:00

11 KiB

Raw Blame History

Querying All API Versions

Function

This API is used to query all available API versions.

URI

GET /

Request

N/A

Response

Response parameters:

Table 1 describes the response parameters.

**Table 1** Response parameters
Parameter	Type	Description
versions	Array	API version list.

**Table 2** Data structure of the versions field
Parameter	Mandatory	Type	Description
id	Yes	String	API version ID, for example, v3.
links	Yes	String	API URL.
min_version	No	String	API microversion. If the API has microversions, the parameter value is the earliest version number supported. If the API does not have microversions, the parameter is left blank.
status	Yes	String	API version status. CURRENT: The version is a mainstream version. SUPPORTED: The version is not the latest one but it is still in use. DEPRECATED: The version is deprecated and will probably be deleted.
updated	Yes	String	Version release time in UTC. For example, the parameter value for v1 is 2014-06-28T12:20:21Z.
version	Yes	String	API version number. If the API version has microversions, the parameter value is the highest version number supported. If the API version does not have API mini versions, the parameter is left blank.

Example response:

{
    "versions": [
        {
            "id": "v3",
            "links": [
                {
                    "href": "https://container.eu-de.***.t-systems.com/v3",
                    "rel": "self"
                }
            ],
            "min_version": "",
            "status": "CURRENT",
            "updated": "2018-09-15T00:00:00Z",
            "version": ""
        }
    ]
}

Status Code

Table 3 describes the status code of the API.

**Table 3** Status code
Status Code	Description
200	The query operation is successful.

For details about error status codes, see Status Code.

Parent topic: API Version Query

11 KiB Raw Blame History