Querying a Specified API Version
Function
This API is used to query a specified API version.
Constraints
None
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 /{api_version}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| api_version | Yes | String | API version |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Message body type (format). Possible values: application/json;charset=utf-8 application/json |
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| version | VersionDetail object | List of all versions |
| Parameter | Type | Description |
|---|---|---|
| id | String | Version ID |
| links | Link object | URL of the API |
| version | String | If microversions are supported, set this parameter to the maximum microversion supported. Otherwise, leave this parameter empty. |
| status | String | Version status. The value can be as follows: CURRENT: The version is the primary version. SUPPORTED: The version is an earlier version, but it is still supported. DEPRECATED: The version is a deprecated version, which may be deleted later. |
| updated | String | The version release time in UTC. For example, the release time of v1 is 2014-06-28T12:20:21Z. |
| min_version | String | If microversions are supported, set this parameter to the minimum microversion supported. Otherwise, leave this parameter empty. |
Example Requests
GET https://{endpoint}/{api_version} Example Responses
Status code: 200
{
"version" : {
"id" : "v2",
"links" : {
"href" : "https://swr-api-domain-name/v2/",
"rel" : "self"
},
"min_version" : "2.0",
"status" : "CURRENT",
"updated" : "2017-12-09T00:00:00Z",
"version" : "2.26"
}
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The query succeeded. |
| 500 | An internal error occurred. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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