Querying an API Version
Function
This API is used to query a specified API version of OMS.
Calling Method
For details, see Calling APIs.
URI
GET /{version}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
version |
Yes |
String |
The version. Minimum length: 1 character Maximum length: 10 characters |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
The token used for IAM authentication. Minimum length: 1 character Maximum length: 16,384 characters |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
The API version, for example, v1. |
|
links |
Array of Link objects |
The link address. Array length: 0 to 100 |
|
status |
String |
The version status. CURRENT: indicates a widely used version. SUPPORTED: indicates an earlier version which is still supported. DEPRECATED: indicates a deprecated version which may be deleted later. The value can be: |
|
updated |
String |
The time when the version is updated. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the UTC. Minimum length: 0 characters Maximum length: 32 characters |
|
Parameter |
Type |
Description |
|---|---|---|
|
href |
String |
The link address. |
|
rel |
String |
Its value is self, indicating that href is a local link. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_msg |
String |
The error message. |
|
error_code |
String |
The error code. |
Example Request
This example queries a specified OMS API version.
GET https://{endpoint}/v2
Example Response
Status code: 200
The version information is obtained.
{
"links" : [ {
"rel" : "self",
"href" : "https://oms.cn-north-1.myhuaweicloud.com/v1/"
} ],
"id" : "v2",
"updated" : "2020-04-01T12:00:00Z",
"status" : "SUPPORTED"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The version information is obtained. |
|
403 |
Forbidden |
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.
