Updated on 2026-01-08 GMT+08:00

Querying API Version Information

API Description

This API is used to query the specified API version.

URI

  • URI format

    GET https://{Endpoint}/{version}

Request Parameters

None

Response Parameters

  • Parameter description
    Table 1 Parameter description

    Parameter

    Type

    Mandatory

    Description

    versions

    Array of objects

    No

    API version information. For details, see Table 2.

    Table 2 versions field data structure description

    Parameter

    Type

    Mandatory

    Description

    id

    String

    Yes

    API version.

    links

    Array of objects

    Yes

    API link information. For details, see Table 3.

    NOTE:

    If the version is v3, the value is [].

    status

    String

    Yes

    Version status.

    The value is CURRENT, indicating that the version has been released.

    version

    String

    Yes

    Subversion information of the API version.

    min_version

    String

    Yes

    Minimum API version number.

    updated

    String

    Yes

    Version update time.

    The value is in the "yyyy-mm-ddThh:mm:ssZ" format.

    T is the separator between the calendar and the hourly notation of time. Z indicates the UTC.

    Table 3 links field data structure description

    Parameter

    Type

    Mandatory

    Description

    href

    String

    No

    API URL. The value is "".

    rel

    String

    No

    Its value is self, indicating that the URL is a local link.

  • Response example
    {
        "version": {
            "id": "v3",
            "links": [],
            "status": "CURRENT",
            "version": "",
            "min_version": "",
            "updated": "2017-02-07T17:34:02Z"
        }
    }

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.