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

Querying API Versions

Function

This API is used to query the API versions supported by RDS.

URI

  • URI format

    GET /

  • Parameter description

    None

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/

Response

  • Normal response
    Table 1 Parameters

    Parameter

    Type

    Description

    versions

    Array of objects

    Definition

    List of detailed API version information.

    For details, see Table 2.

    Table 2 versions field data structure description

    Parameter

    Type

    Description

    id

    String

    Definition

    API version.

    Range

    • v1: API v1 version
    • v3: API v3 version

    links

    Array of objects

    Definition

    API links. The value is empty when the version is v1 or v3.

    For details, see Table 3.

    status

    String

    Definition

    Version status.

    Range

    • CURRENT: recommended version
    • DEPRECATED: deprecated version which may be deleted later

    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 Coordinated Universal Time (UTC).

    Table 3 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
    {
    	"versions": [{
    			"id": "v3",
    			"links": [],
    			"status": "CURRENT",
    			"updated": "2019-01-15T12:00:00Z"
    		},
    		{
    			"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.