Help Center/ Server Migration Service/ API Reference/ API/ API Version Query/ Querying an SMS API Version
Updated on 2026-01-27 GMT+08:00
View PDF

Querying an SMS API Version

Function

This API is used to query a specified API version of SMS.

Calling Method

For details, see Calling APIs.

URI

GET /{version}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

version

Yes

String

Version information, for example, v3.

Minimum: 1

Maximum: 10

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

The API version.

Minimum: 0

Maximum: 255

links

Array of Link objects

The API link address.

Array Length: 0 - 1024

status

String

The version status. SUPPORTED indicates that the version is supported.

Minimum: 0

Maximum: 255

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). For example, 2018-09-30T00:00:00Z

Minimum: 0

Maximum: 255
Table 4 Link

Parameter

Type

Description

href

String

The API URL.

Minimum: 0

Maximum: 1024

rel

String

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

Minimum: 0

Maximum: 1024

Example Requests

This example queries a specified SMS API version.

GET https://{endpoint}/v3

{
  "links" : [ {
    "rel" : "self",
    "href" : "https://{endpoint}/v3"
  } ],
  "id" : "v3",
  "updated" : "2020-09-02T17:50:00Z",
  "status" : "SUPPORTED"
}

Example Responses

Status code: 200

Querying an SMS API Version Successfully

{
  "links" : [ {
    "rel" : "self",
    "href" : "https://{endpoint}/v3"
  } ],
  "id" : "v3",
  "updated" : "2020-09-02T17:50:00Z",
  "status" : "SUPPORTED"
}

Status Codes

Status Code

Description

200

Querying an SMS API Version Successfully

Error Codes

See Error Codes.

Parent topic: API Version Query