Querying a Specified API Version
Function
This API is used to query a specified API version supported by Cloud Eye.
URI
GET /{api_version}
- Parameter description
Table 1 Parameter description Parameter
Mandatory
Description
api_version
Yes
Specifies the API version.
- Example
GET https://{Cloud Eye endpoint}/V1.0
Request
None
Response
- Response parameters
Table 2 Response parameters Parameter
Type
Description
version
Objects
Specifies the list of all versions.
For details, see Table 3.
Table 3 versions field data structure description Parameter
Type
Description
id
String
Specifies the version ID, for example, v1.
links
Array of objects
Specifies the API URL.
For details, see Table 4.
version
String
Specifies the API version. 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 blank.
status
String
Specifies the version status. Possible values are as follows:
CURRENT: indicates a primary version.
SUPPORTED: indicates an old version but is still supported.
DEPRECATED: indicates a deprecated version which may be deleted later.
updated
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
String
If the APIs of this version support microversions, set this parameter to the supported minimum microversion. If not, leave this parameter blank.
- 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": "" } }
Returned Value
- Normal
- Abnormal
Returned Value
Description
400 Bad Request
Request error
401 Unauthorized
The authentication information is not provided or is incorrect.
403 Forbidden
You are forbidden to access the page requested.
408 Request Timeout
The request timed out.
429 Too Many Requests
Concurrent requests are excessive.
500 Internal Server Error
Failed to complete the request because of an internal service error.
503 Service Unavailable
The service is currently unavailable.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot