文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 查询API版本/ 查询API版本列表
更新时间：2024-11-04 GMT+08:00
查看PDF
分享

查询API版本列表

功能介绍

查询API版本列表。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

  • URL格式

GET /

  • 参数说明

    无。

请求参数

无。

请求示例

查询API版本列表。

GET https://{endpoint}/

响应消息

  • 正常响应参数说明
表1 响应Body参数

参数

参数类型

描述

versions

Array of ApiVersion objects

API版本详细信息列表links
表2 ApiVersion

参数

参数类型

描述

id

String

API版本号,如v1、v3。

links

Array of LinkInfo objects

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

status

String

版本状态。

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

取值“SUPPORTED”,表示为老版本,但是现在还继续支持

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

version

String

若该版本API支持微版本,则填支持的最大微版本号,如果不支持微版本,则填空

updated

String

版本更新时间。格式为“yyyy-mm-dd Thh:mm:ssZ”。其中,T指某个时间的开始;Z指UTC时间。
表3 LinkInfo

参数

参数类型

描述

href

String

对应该API的URL。

rel

String

取值为“self”,表示href为本地链接。
  • 正常响应示例
{
  "versions": [
    {
      "id": "v3",
      "links": [],
      "status": "CURRENT",
      "updated": "2019-01-15T12:00:00Z",
      "version":""
    },
    {
      "id": "v1",
      "links": [],
      "status": "DEPRECATED",
      "updated": "2017-02-07T17:34:02Z",
      "version":""
    }
  ]
}

状态码

错误码

请参见错误码。

父主题： 查询API版本

相关文档