Help Center/Server Migration Service/API Reference (Ally Region)/API/API Version Query/Listing SMS API Versions
Updated on 2026-01-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Listing SMS API Versions

Function

This API is used to list all SMS 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 user token. The token 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.

Minimum length: 1 character

Maximum length: 16,384 characters

Response

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

versions

Array of Version objects

The list of all SMS API versions.

Array length: 0 to 1,024

Table 3 Version

Parameter

Type

Description

id

String

The API version.

Minimum length: 0 characters

Maximum length: 255 characters

links

Array of Link objects

The API link address.

Array length: 0 to 1,024

status

String

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

Minimum length: 0 characters

Maximum length: 255 characters

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

Minimum length: 0 characters

Maximum length: 255 characters

Table 4 Link

Parameter

Type

Description

href

String

The API URL.

Minimum length: 0 characters

Maximum length: 1,024 characters

rel

String

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

Minimum length: 0 characters

Maximum length: 1,024 characters

Example Request

This example queries the list of supported API versions.

GET https://{endpoint}/

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

Example Response

Status code: 200

The list of supported API versions was obtained.

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

Status Codes

Status Code

Description

200

The list of supported API versions was obtained.

Error Codes

For details, see Error Codes.

Parent topic:API Version Query