Updated on 2022-02-22 GMT+08:00

Querying a Specified 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 Message

  • Request parameters

    None

  • Example request

    This example shows how to query V1 AS API.

    GET https://{Endpoint}/v1

Response Message

  • Response parameters
    Table 2 Response parameters

    Parameter

    Type

    Description

    version

    Object

    Specifies a specified API version.

    Table 3 version field description

    Parameter

    Type

    Description

    id

    String

    Specifies the API version ID.

    links

    Array

    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

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The server failed to process the request.

    401 Unauthorized

    You must enter the username and password to access the requested page.

    403 Forbidden

    You are forbidden to access the requested page.

    404 Not Found

    The server could not find the requested page.

    405 Method Not Allowed

    You are not allowed to use the method specified in the request.

    406 Not Acceptable

    The response generated by the server could not be accepted by the client.

    407 Proxy Authentication Required

    You must use the proxy server for authentication so that the request can be processed.

    408 Request Timeout

    The request timed out.

    409 Conflict

    The request could not be processed due to a conflict.

    500 Internal Server Error

    Failed to complete the request because of an internal service error.

    501 Not Implemented

    Failed to complete the request because the server does not support the requested function.

    502 Bad Gateway

    Failed to complete the request because the request is invalid.

    503 Service Unavailable

    Failed to complete the request because the system is unavailable.

    504 Gateway Timeout

    A gateway timeout error occurred.

Error Codes

See Error Codes.