• Cloud Container Engine

cce
  1. Help Center
  2. Cloud Container Engine
  3. API Reference 2.0
  4. API
  5. API Version Query
  6. Querying Information About API v3

Querying Information About API v3

Function

This API is used to query information about API v3.

URI

GET /v3

Request

N/A

Response

Response parameters:

Table 2 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 mini version number.

  • If the API version has mini versions, the parameter value is the lowest version number supported.
  • If the API version does not have API mini versions, 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 mini versions, 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.otc.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 Codes.