Updated on 2023-11-24 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}

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3

Requests

None

Responses

  • Parameter description
    Table 1 Parameter description

    Name

    Type

    Mandatory

    Description

    versions

    Array of objects

    No

    Indicates the list of detailed API version information. For more information, see Table 2.

    Table 2 versions field data structure description

    Name

    Type

    Mandatory

    Description

    id

    String

    Yes

    Indicates the API version.

    links

    Array of objects

    Yes

    Indicates the API link information. For more information, see Table 3.

    NOTE:

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

    status

    String

    Yes

    Version status

    The value CURRENT indicates that the version has been released.

    version

    String

    Yes

    Indicates the subversion of the API version.

    min_version

    String

    Yes

    Indicates the minimum API version.

    updated

    String

    Yes

    Indicates the version update time.

    The format is yyyy-mm-ddThh:mm:ssZ.

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

    Table 3 links field data structure description

    Name

    Type

    Mandatory

    Description

    href

    String

    No

    Indicates the API URL and the value is "".

    rel

    String

    No

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

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

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.