Querying Details About an API Version
Function
This API is used to query details about an API version.
URI
GET /{api_version}
Request
- Parameter description
Table 1 Parameter in the request Name
Mandatory
Type
Description
api_version
Yes
String
Specifies the version ID, for example, v1.0.
- Example request
GET https://{EPS endpoint}/v1.0
Response
- Parameter description
Table 2 Parameter in the response Name
Type
Description
version
Object
Specifies the version details.
For details, see Table 3.
- versions field data structure
Table 3 versions field data structure description Name
Type
Description
id
String
Specifies the version ID, for example, v1.0.
links
List<Link>
Specifies the API URL.
For details, see Table 4.
version
String
Specifies the microversion. If APIs of a version support microversions, the maximum microversion supported is returned. If microversions are not supported, this field is left empty.
status
String
Specifies the version status. The options are as follows:
- CURRENT: indicates a primary version.
- SUPPORTED: indicates an old version that is still supported.
- DEPRECATED: indicates a deprecated version that 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
Specifies the microversion. If APIs of a version support microversions, the minimum microversion supported is returned. If microversions are not supported, this field is left empty.
- Link field data structure
- Example response
{ "version": { "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
For details, see Status Code.
Error Codes
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