On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Management APIs/ Querying Key API Versions/ Query version list

Query version list

Updated on 2024-08-06 GMT+08:00

View PDF

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	Related version object list. For details, see the data structure description of the versions field.

**Table 2** 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 3** ApiLink
Parameter	Type	Description
href	String	API URL.
rel	String	The default value is self.

Status code: 500

**Table 4** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 5** 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 6** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 7** 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 8** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 9** 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

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.
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

Previous topic: Querying Key API Versions

Next topic: Key Import Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot