Querying a Specific API Version

Function

This API is used to query a specified API version of Cloud Eye.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /{api_version}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
api_version	Yes	String	Definition API version. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
version	APIVersionResp object	Definition Version details. Range N/A

**Table 3** APIVersionResp
Parameter	Type	Description
id	String	Definition Version ID (version number), for example, v1. Range N/A
links	Array of LinkResp objects	Definition API URL. Range N/A
version	String	Definition If the APIs of this version support micro versions, this parameter indicates the supported maximum micro version. If not, it is left blank. Range N/A
status	String	Definition Version status. Range The value can only be: 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 micro versions, this parameter indicates the supported minimum micro version. If not, it is left blank. Range N/A

**Table 4** LinkResp
Parameter	Type	Description
href	String	Definition Reference address of the current API version. Range N/A
rel	String	Definition Relationship between the current API version and the referenced address. Range N/A

Example Requests

Example request

GET https://{Cloud Eye endpoint}/V1.0

Example Responses

Status code: 200

{
  "version" : {
    "id" : "V1.0",
    "links" : [ {
      "href" : "https://x.x.x.x/V1.0/",
      "rel" : "self"
    } ],
    "version" : "",
    "status" : "CURRENT",
    "updated" : "2018-09-30T00:00:00Z",
    "min_version" : ""
  }
}