Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Management APIs/ Querying Key API Versions/ Querying a Specified Version
Updated on 2025-09-15 GMT+08:00
View PDF

Querying a Specified Version

Function

This API is used to query a specified API version.

Calling Method

For details, see Calling APIs.

URI

GET /{version_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

version_id

Yes

String

API version.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

version

Object

Version object list. For details, see the data structure description of the ApiVersionDetail field.
Table 3 ApiVersionDetail

Parameter

Type

Description

id

String

Version number, for example, v1.0.

links

Array of ApiLink objects

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

version

String

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

status

String

Version status. Possible values are as follows:

CURRENT: The version is widely used.

SUPPORTED: It is an earlier version which can still be used.

DEPRECATED: The version is deprecated and may be deleted later.

updated

String

Version release time. The time must be in UTC format. For example, v1 is released on 2014-06-28T12:20:21Z.

min_version

String

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

Parameter

Type

Description

href

String

API URL.

rel

String

The default value is self.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 502

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Status code: 504

Table 9 Response body parameters

Parameter

Type

Description

error

Object

Error message
Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code returned by the error request

error_msg

String

Error information returned by the error request

Example Requests

Query the V1.0 API information of the current site.

/v1.0

Example Responses

Status code: 200

A specified API version is queried.

{
  "version" : {
    "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

A specified API version is queried.

500

Internal service error.

502

Failed to complete the request. The server receives an invalid response from the upstream server.

504

Gateway timed out.

Error Codes

See Error Codes.

Parent Topic: Querying Key API Versions