Querying API Versions

Function

This interface is used to query all API versions of the AS service.

URI

GET /

Request

None

Example Request

This example queries all available API versions.
GET https://{Endpoint}/

Response

Table 1 Response parameters

Parameter

Type

Description

versions

Array of versions objects

Specifies the API versions.

Table 2 versions field description

Parameter

Type

Description

id

String

Specifies the API version ID.

links

Array of links objects

Specifies the API URL. For details, see Table 3.

min_version

String

Specifies the earliest supported API version number.

status

String

Specifies the API version status.

  • CURRENT: indicates a primary version.
  • SUPPORTED: indicates an earlier version which is still supported.
  • DEPRECATED: indicates a deprecated version which may be deleted later.

updated

String

Specifies the release date of an API version.

version

String

Specifies the latest supported API version number.

Table 3 links field description

Parameter

Type

Description

href

String

Specifies the API Uniform Resource Locator (URL).

rel

String

Specifies the API URL dependency.

Example Response

{
  "versions": [
    {
      "id": "v1",
      "links": [
        {
          "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/",
          "rel": "self"
        }
      ],
      "min_version": "",
      "status": "CURRENT",
      "updated": "2016-06-30T00:00:00Z",
      "version": ""
    },
    {
      "id": "v2",
      "links": [
        {
          "href": "https://as.XXX.mycloud.com/autoscaling-api/v2/",
          "rel": "self"
        }
      ],
      "min_version": "",
      "status": "SUPPORTED",
      "updated": "2018-03-30T00:00:00Z",
      "version": ""
    }
  ]
}

Returned Values

Error Codes

See Error Codes.