Help Center/ Data Encryption Workshop/ API Reference/ API/ Key Management APIs/ Querying Key API Versions/ Querying the Version List
Updated on 2026-09-21 GMT+08:00
View PDF

Querying the Version List

Function

This API is used to query the API version list.

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

Array of ApiVersionDetail objects

Definition

List of version objects

Range

N/A
Table 2 ApiVersionDetail

Parameter

Type

Description

id

String

Definition

Version ID, for example, v1.0.

Range

N/A

links

Array of ApiLink objects

Definition

JSON object. For details, see the data structure of the links field.

Range

N/A

version

String

Definition

If the APIs of this version support microversions, the supported maximum microversion is returned. If microversions are not supported, an empty string is returned.

Range

N/A

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.

updated

String

Definition

Version release time in UTC. For example, the release time of v1 is 2014-06-28T12:20:21Z.

Range

N/A

min_version

String

Definition

If the APIs of this version support microversions, the supported minimum microversion is returned. If microversions are not supported, an empty string is returned.

Range

N/A
Table 3 ApiLink

Parameter

Type

Description

href

String

Definition

API URL

Range

N/A

rel

String

Definition

The default value is self.

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "versions" : [ {
    "min_version" : "",
    "links" : [ {
      "rel" : "self",
      "href" : "https://kms.region_id.domain.com/v1.0/"
    } ],
    "id" : "v1.0",
    "version" : "",
    "updated" : "2016-10-29T02:00:00Z",
    "status" : "CURRENT"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Querying Key API Versions