Updated on 2025-08-19 GMT+08:00

Obtaining API Versions

Function

This API is used to query all API versions supported by the DNS service.

Calling Method

For details, see Calling APIs.

URI

GET /

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

versions

valuesItem object

Definition

API version list

Range

N/A

Table 2 valuesItem

Parameter

Type

Description

values

Array of ListApiVersionsItem objects

Definition

List of all versions

Range

N/A

Table 3 ListApiVersionsItem

Parameter

Type

Description

status

String

Definition

Version status

Range

  • CURRENT: This version is a primary version.

  • SUPPORTED: This version is an earlier version that is still supported.

  • DEPRECATED: The version is a deprecated version, which may be deleted later.

id

String

Definition

Version

Range

v2

links

Array of LinksItem objects

Definition

URL of the current version

Range

N/A

Table 4 LinksItem

Parameter

Type

Description

href

String

Definition

Shortcut link

Range

N/A

rel

String

Definition

Shortcut link marker name

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

Querying all API versions supported by the DNS service.

GET https://{endpoint}/

Example Responses

Status code: 200

Response of querying API versions

{
  "versions" : {
    "values" : [ {
      "status" : "CURRENT",
      "id" : "v2",
      "links" : [ {
        "href" : "https://Endpoint/v2",
        "rel" : "self"
      } ]
    } ]
  }
}

Status Codes

Status Code

Description

200

Response of querying API versions

400

Error response

404

Error response

500

Error response

Error Codes

See Error Codes.