Querying a Version

Function

Description: This API is used to query a specified API version.

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 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. It can be: CURRENT: widely used version SUPPORTED: earlier version which is still supported DEPRECATED: deprecated version which may be deleted later
updated	String	Coordinated Universal time (UTC) time when the version was released. For example, the value is 2014-06-28T12:20:21Z for v1.
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 for an error request.
error_msg	String	Error information returned for an 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 for an error request.
error_msg	String	Error information returned for an 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 for an error request.
error_msg	String	Error information returned for an error request.

Example Requests

None

Example Responses

Status code: 200

This API is used to query a specified API 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	This API is used to query a specified API version.
500	Internal service error.
502	Failed to complete the request. The server received an invalid response.
504	Gateway timed out.