Querying All API Versions
Function
This API is used to query all API versions supported by CTS.
URI
GET /
Request
None
Response
- Parameter description
Table 1 Parameters in the response Parameter
Mandatory
Type
Description
version
Yes
Array
Specifies the list of all API versions.
id
Yes
String
Specifies the version ID (version number), for example, v1.
links
Yes
String
Specifies the API URL.
href
Yes
String
Specifies the reference address of the current API version.
rel
Yes
String
Specifies the relationship between the current API version and the referenced address.
version
Yes
String
If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If the microversion is not supported, leave this parameter empty.
status
Yes
String
Specifies the version status. The options are as follows:
CURRENT: indicates that the version is the primary version.
SUPPORTED: indicates that the version is an old version, but it is still supported.
DEPRECATED: indicates that the version is a deprecated version, which may be deleted later.
updated
Yes
String
Specifies the version release time, which must be the UTC time. For example, the release time of v1 is 2014-06-28T12:20:21Z.
min_version
No
String
If the APIs of this version support microversions, set this parameter to the supported minimum microversion. If the microversion is not supported, leave this parameter empty.
- Example response
{ "version": [ { "id": "v1.0", "links": [ { "href": "https://x.x.x.x/v1.0/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2018-09-30T00:00:00Z", "version": "" } { "id": "v2.0", "links": [ { "href": "https://x.x.x.x/v2.0/", "rel": "self" } ], "min_version": "", "status": "SUPPORTED", "updated": "2018-09-30T00:00:00Z", "version": "" } ] }
Returned Value
- Normal
200
- Abnormal
Table 2 Return code for failed requests Returned Value
Description
400 Bad Request
Request error.
401 Unauthorized
The authentication information is not provided or is incorrect.
403 Forbidden
The request was forbidden.
404 Not Found
The server failed to find the requested resource.
408 Request Timeout
The request timed out.
429 Too Many Requests
The number requests exceeded the upper limit.
500 Internal Server Error
Failed to complete the request because of an internal service error.
503 Service Unavailable
The service is currently unavailable.
Last Article: API Version Management
Next Article: Querying a Specified API Version
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.