Querying a Specified API Version

Function

This API is used to query the specified API version.

  • Before calling an API, you need to understand the API in Authentication.

  • Before calling this API, obtain the required region and endpoint.

URI

  • URI format

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

  • Parameter description

    Table 1 Parameter description

    Name

    Mandatory

    Description

    version

    Yes

    Specifies the API version. It is case-sensitive.

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

Request

GET https://{Endpoint}/rds/v3

Response

  • Normal response

    Table 2 Parameter description

    Name

    Type

    Description

    versions

    Object

    Indicates the list of detailed API version information.

    For details, see Table 3.

    version

    Object

    Indicates the list of detailed API version information.

    For details, see Table 3.

    Table 3 versions field data structure description

    Name

    Type

    Description

    id

    String

    Indicates the API version.

    links

    Array

    Indicates the API version link information. Its value is empty.

    For details, see Table 4.

    status

    String

    Indicates the version status.

    CURRENT: indicates that the version is recommended.

    DEPRECATED: indicates a deprecated version which may be deleted later.

    updated

    String

    Indicates the version update time.

    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

    Name

    Type

    Description

    href

    String

    Indicates the API URL and the value is "".

    rel

    String

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

  • Example normal response

    {
      "version": {
        "id": "v3",
        "links": [],
        "status": "CURRENT",
        "updated": "2017-02-07T17:34:02Z"
      },
      "versions": {
        "id": "v3",
        "links": [],
        "status": "CURRENT",
        "updated": "2017-02-07T17:34:02Z"
      }
    }
    
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.