Updated on 2023-07-03 GMT+08:00

Listing API Versions

Function

This API is used to query the list of API versions supported by CCE.

URI

GET /

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

versions

Array of APIVersionDetail objects

API version list.

Table 2 APIVersionDetail

Parameter

Type

Description

id

String

API version ID. Example: v3

links

Array of APIVersionLink objects

URL of the API version.

min_version

String

Microversion. If the APIs of this version support microversions, set this parameter to the supported minimum microversion. If no microversion is supported, leave this parameter blank.

status

String

API version status. Possible values:

  • CURRENT: preferred API version

  • SUPPORTED: old API version that is still supported

  • DEPRECATED: discarded API version that will be deleted

updated

String

Time when the API was released (UTC). For example, if the API version is v3, the value is '2018-09-15 00:00:00Z'.

version

String

Microversion. If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If no microversion is supported, leave this parameter blank.

Example Requests

None

Example Responses

Status code: 200

The API version list is queried successfully.

{
  "versions" : [ {
    "id" : "v3",
    "links" : [ {
      "href" : "https://cce.region.***.com/v3",
      "rel" : "self"
    } ],
    "min_version" : "",
    "status" : "CURRENT",
    "updated" : "2018-09-15 00:00:00Z",
    "version" : ""
  } ]
}

Status Codes

Status Code

Description

200

The API version list is queried successfully.

Error Codes

See Error Codes.