更新时间:2022-03-10 GMT+08:00

查询API版本列表

功能介绍

查询关系型数据库当前支持的API版本列表。

v1接口资料已下线,对应软件也即将下线,为了不影响您的业务,强烈建议您将业务切换到v3接口。

URI

  • URI格式

    GET https://{Endpoint}/rds/

  • URI样例

    https://{Endpoint}/rds/

  • 参数说明

    无。

请求消息

无。

响应消息

  • 正常响应要素说明
    表1 要素说明

    名称

    参数类型

    说明

    versions

    Array of objects

    API版本详细信息列表。

    详情请参见表2

    表2 versions字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    API版本号。

    各个版本号,对应如下:

    • v1:API v1版本。
      须知:

      v1接口资料已下线,对应软件也即将下线,为了不影响您的业务,强烈建议您将业务切换到v3接口。

    • v3:API v3版本。

    links

    Array of objects

    对应API的链接信息,v1、v3版本该字段为空。

    详情请参见表3

    status

    String

    版本状态。

    取值“CURRENT”,表示该版本为主推版本。

    取值“DEPRECATED”,表示为废弃版本,存在后续删除的可能。

    updated

    String

    版本更新时间。

    格式为“yyyy-mm-dd Thh:mm:ssZ”。

    其中,T指某个时间的开始;Z指UTC时间。

    表3 links字段数据结构说明

    名称

    参数类型

    说明

    href

    String

    对应该API的URL,该字段为""。

    rel

    String

    取值为“self”,表示href为本地链接。

  • 正常响应样例
    {
    	"versions": [{
    			"id": "v3",
    			"links": [],
    			"status": "CURRENT",
    			"updated": "2019-01-15T12:00:00Z"
    		},
    		{
    			"id": "v1",
    			"links": [],
    			"status": "DEPRECATED",
    			"updated": "2017-02-07T17:34:02Z"
    		}
    	]
    }
  • 异常响应

    请参见异常请求结果

状态码

请参见状态码

错误码

请参见错误码