Updated on 2025-08-20 GMT+08:00

Querying a Specified API Version

Function

This API is used to query the specified API version.

URI

  • URI format

    GET /rds/{version}

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    version

    Yes

    Definition

    API version.

    Constraints

    N/A

    Range

    The value is case-sensitive.

    For details, see id in Table 2 in section Querying API Versions.

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/rds/v1

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    versions

    Object

    Definition

    API version details.

    For details, see Table 3.

    version

    Object

    Definition

    API version details.

    For details, see Table 3.

    Table 3 versions field data structure description

    Parameter

    Type

    Description

    id

    String

    Definition

    API version.

    Range

    N/A

    links

    Array

    Definition

    API version link information. Its value is empty.

    For details, see Table 4.

    status

    String

    Definition

    Version status.

    Range

    N/A

    updated

    String

    Definition

    Version update time.

    Range

    The format is yyyy-mm-dd Thh:mm:ssZ.

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

    Table 4 links field data structure description

    Parameter

    Type

    Description

    href

    String

    Definition

    URL of the API.

    Range

    The value is "".

    rel

    String

    Definition

    URL type.

    Range

    The value is self, indicating that href is a local link.

  • Example normal response
    {
      "version": {
        "id": "v1",
        "links": [],
        "status": "DEPRECATED",
        "updated": "2017-02-07T17:34:02Z"
      },
      "versions": {
        "id": "v1",
        "links": [],
        "status": "DEPRECATED",
        "updated": "2017-02-07T17:34:02Z"
      }
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.