Updated on 2023-12-15 GMT+08:00

Querying API Versions

Function

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

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

URI

  • URI format

    GET /

  • Parameter description

    None

Request

  • Request parameters

    None

  • URI example

    GET https://{endpoint}/

Response

  • Normal response
    Table 1 Parameter description

    Name

    Type

    Description

    versions

    Array of objects

    List of detailed API version information.

    For details, see Table 2.

    Table 2 versions field data structure description

    Name

    Type

    Description

    id

    String

    API version.

    Its value can be:

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

    links

    Array of objects

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

    For details, see Table 3.

    status

    String

    Version status.

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

    updated

    String

    Version update time in the "yyyy-mm-dd Thh:mm:ssZ" format.

    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

    Name

    Type

    Description

    href

    String

    API URL. The value is "".

    rel

    String

    Its 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.