Querying an API Version

Function

This interface is used to query a specified API version of the AS service.

URI

GET /{api_version}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

api_version

Yes

String

Specifies the ID of the AS API version.

Request

None

Example Request

This example queries the API version of V1.

GET https://{Endpoint}/v1

Response

Table 2 Response parameters

Parameter

Type

Description

version

version object

Specifies a specified API version.

Table 3 version 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 4.

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 4 links field description

Parameter

Type

Description

href

String

Specifies the API Uniform Resource Locator (URL).

rel

String

Specifies the API URL dependency.

Example Response

{
  "version": {
    "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": ""
  }
}

Returned Values

Error Codes

See Error Codes.