Help Center/ Object Storage Migration Service/ API Reference/ APIs V2 (Recommended)/ API Version Query/ Listing API Versions
Updated on 2024-12-30 GMT+08:00
View PDF

Listing API Versions

Function

This API is used to list all OMS API versions.

Calling Method

For details, see Calling APIs.

URI

GET /

Request

Table 1 Request header parameters

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

Table 2 Response body parameter

Parameter

Type

Description

versions

Array of Version objects

The version list.

Array length: 0 to 1,024
Table 3 Version

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:

  • CURRENT

  • DEPRECATED

  • SUPPORTED

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 Coordinated Universal Time (UTC).

Minimum length: 0 characters

Maximum length: 32 characters
Table 4 Link field description

Parameter

Type

Description

href

String

The link address.

rel

String

Its value is self, indicating that href is a local link.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

The error message.

error_code

String

The error code.

Example Request

This example queries the list of supported API versions.

GET https://{endpoint}/

Example Response

Status code: 200

OK

{
  "versions" : [ {
    "links" : [ {
      "rel" : "self",
      "href" : "https://oms.cn-north-1.myhuaweicloud.com/v1/"
    } ],
    "id" : "v1",
    "updated" : "2020-01-01T12:00:00Z",
    "status" : "SUPPORTED"
  }, {
    "links" : [ {
      "rel" : "self",
      "href" : "https://oms.cn-north-1.myhuaweicloud.com/v2/"
    } ],
    "id" : "v1",
    "updated" : "2020-01-01T12:00:00Z",
    "status" : "SUPPORTED"
  } ]
}

Status Codes

Status Code

Description

200

OK

403

Forbidden

Error Codes

For details, see Error Codes.

Parent topic: API Version Query