Help Center/ Object Storage Migration Service/ API Reference/ APIs V2/ API Version Query/ Query an API Version
Updated on 2026-06-30 GMT+08:00
View PDF

Query 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}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

version

Yes

String

The version information.

Minimum: 1

Maximum: 10

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The token used for IAM authentication.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

The API version, for example, v1.

links

Array of Link objects

The link address.

Array Length: 0 - 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.

Enumeration values:

  • CURRENT

  • DEPRECATED

  • SUPPORTED

updated

String

The time when the version was 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 Coordinated Universal Time (UTC).

Minimum: 0

Maximum: 32
Table 4 Link

Parameter

Type

Description

href

String

Link address.

rel

String

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

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

This example queries a specified API version.

GET https://{endpoint}/v2

Example Responses

Status code: 200

The version information.

{
  "links" : [ {
    "rel" : "self",
    "href" : "https://oms.cn-north-1.myhuaweicloud.com/v1/"
  } ],
  "id" : "v2",
  "updated" : "2020-04-01T12:00:00Z",
  "status" : {
    "type" : "string",
    "example" : "SUPPORTED",
    "description" : "The version status. The default value is **SUPPORTED**.\n**CURRENT**: indicates a widely used version.\n**DEPRECATED**: indicates a deprecated version which may be deleted later.\n**SUPPORTED** (default value): indicates an earlier version which is still supported.",
    "enum" : [ "CURRENT", "DEPRECATED", "SUPPORTED" ],
    "default" : "SUPPORTED"
  }
}

Status Codes

Status Code

Description

200

The version information.

403

Forbidden

Error Codes

See Error Codes.

Parent Topic: API Version Query