Querying API Versions
Function
This API is used to query the versions of EPS APIs.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
versions |
Array of VersionDetail objects |
Version list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Version ID, for example, v1.0. |
|
links |
Array of Link objects |
API URL. |
|
version |
String |
If the APIs of this version support minor versions, the latest minor version is returned. If minor versions are not supported, an empty string is returned. |
|
status |
String |
Version status. Possible values are as follows: CURRENT: primary version. SUPPORTED: earlier version which is still supported. DEPRECATED: deprecated version which may be deleted later. |
|
updated |
String |
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 the APIs of this version support minor versions, the earliest minor version is returned. If minor versions are not supported, an empty string is returned. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 405
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 406
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 408
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 409
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 410
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 412
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 429
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 501
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 503
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
RespErrorMessage object |
Error request information. |
Example Requests
None
Example Responses
Status code: 200
OK
{
"versions" : [ {
"id" : "v1.0",
"links" : [ {
"rel" : "self",
"href" : "https://*API URL*/v1.0"
} ],
"version" : "",
"status" : "CURRENT",
"updated" : "2016-12-09T00:00:00Z",
"min_version" : ""
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not Allowed |
|
406 |
Not Acceptable |
|
408 |
Request Timeout |
|
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.