Querying API Versions
Function
Querying API versions
Calling Method
For details, see Calling APIs.
URI
GET /
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
versions |
Array of VersionDetail objects |
List of versions |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Specifies the version ID, for example, v1.0. |
|
links |
Array of Link objects |
Specifies the API URL. |
|
version |
String |
If there are minor versions, the earliest minor version is returned. If there are no minor versions, null is returned. |
|
status |
String |
Specifies the version status. Possible values are as follows: CURRENT: widely used version SUPPORTED: earlier version which is still supported DEPRECATED: deprecated version which may be deleted later |
|
updated |
String |
Specifies the version release time, which is a UTC time. For example, the release time of v1.0 is 2016-12-09T00:00:00Z. |
|
min_version |
String |
If there are minor versions, the earliest minor version is returned. If there are no minor versions, null is returned. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 405
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 406
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 409
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 410
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 412
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 429
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 501
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Request error code |
|
error_msg |
String |
Error message |
Status code: 503
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Response error information. |
Example Requests
Querying API versions
GET https://{Endpoint}/
Example Responses
Status code: 200
OK
{
"versions" : [ {
"id" : "v1.0",
"links" : [ {
"rel" : "self",
"href" : "https://{Endpoint}/v1.0"
} ],
"version" : "",
"status" : "CURRENT",
"updated" : "2016-12-09T00:00:00Z",
"min_version" : ""
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
406 |
Not Acceptable |
|
409 |
Conflict |
|
410 |
Gone |
|
412 |
Precondition Failed |
|
429 |
Too Many Requests |
|
500 |
Internal Server Error |
|
501 |
Not Implemented |
|
503 |
Service Unavailable |
Error Codes
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