• Cloud Eye

ces
  1. Help Center
  2. Cloud Eye
  3. API Reference
  4. API Description
  5. API Version Management
  6. Querying All API Versions

Querying All API Versions

Function

This API is used to query all API versions supported by Cloud Eye.

URI

GET /

Request

None

Response

  • Response parameters
    Table 1 Response parameters

    Parameter

    Type

    Description

    versions

    Array

    Indicates the list of all versions.

    id

    String

    Indicates the version ID, for example, v1.

    links

    Array

    Indicates the API URL.

    href

    String

    Indicates the reference address of the current API version.

    rel

    String

    Indicates the relationship between the current API version and the referenced address.

    version

    String

    If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If the microversion is not supported, leave this field blank.

    status

    String

    Indicates the version status. Possible values are as follows:

    CURRENT: indicates a primary version.

    SUPPORTED: indicates an old version but is still supported.

    DEPRECATED: indicates a deprecated version which may be deleted later.

    updated

    String

    Indicates the version release time, which must be the UTC time. For example, the release time of v1 is 2014-06-28T12:20:21Z.

    min_version

    String

    If the APIs of this version support microversions, set this parameter to the supported minimum microversion. If the microversion is not supported, leave this field blank.

  • Example response
    {
      "versions": [
        {
          "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

    You are forbidden to access the page requested.

    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 Code

For details, see Error Codes.