Querying a Specified API Version

Function

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

URI

GET /{api_version}

• Parameter description

  Table 1 Parameter description

  Parameter	Mandatory	Description
  api_version	Yes	Definition API version.

• Example

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

Request

None

Response

• Response parameters

  Table 2 Parameter description

  Parameter	Type	Description
  version	Objects	Definition Version details. For details, see Table 3.

  Table 3 versions data structure description

  Parameter	Type	Description
  id	String	Definition Version number, for example, V1.0 Range 1 to 64 characters
  links	Array of objects	Definition API URL. For details, see Table 4.
  version	String	Definition API version. If the APIs of this version support micro versions, this parameter indicates the supported maximum micro version. If not, it is left blank. Range 1 to 64 characters
  status	String	Definition Version status. Range CURRENT: widely used version SUPPORTED: earlier version which is still supported DEPRECATED: 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 API version. If the APIs of this version support micro versions, this parameter indicates the supported minimum micro version. If not, it is left blank. Range 1 to 64 characters

  Table 4 links data structure description

  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 response

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

Returned Values

• Normal

  200

• Abnormal

  Returned Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	The authentication information is not provided or is incorrect.
  403 Forbidden	Access to the requested page is forbidden.
  408 Request Timeout	The request timed out.
  429 Too Many Requests	Concurrent requests are excessive.
  500 Internal Server Error	Failed to complete the request because of an internal service error.
  503 Service Unavailable	The service is currently unavailable.

Error Codes

See Error Codes.