查询API版本信息 - ShowApiVersion

功能介绍

查询API指定版本信息。

• 调用接口前，您需要了解API认证鉴权。
• 调用接口前，您需要了解请求Header参数说明。

调试

您可以在API Explorer中调试该接口。

授权信息

不涉及。

URI

• URI格式

  GET /rds/{version}

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  version	是	参数解释： API版本号。 约束限制： 不涉及。 取值范围： 区分大小写。 详情请参考查询API版本列表 - ListApiVersionNew响应消息表2中的“id”。 默认取值： 不涉及。

请求消息

• 请求参数

  无。

• URI样例

  GET https://{endpoint}/rds/v1

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  versions	Object	参数解释： API版本详细信息列表。 详情请参见表3。
  version	Object	参数解释： API版本详细信息列表。 详情请参见表3。

  表3 versions字段数据结构说明

  名称	参数类型	说明
  id	String	参数解释： API版本号。 取值范围： 不涉及。
  links	Array	参数解释： 对应该API版本的链接信息，该字段为空。 详情请参见表4。
  status	String	参数解释： 版本状态。 取值范围： CURRENT：表示该版本为主推版本。 DEPRECATED：表示为废弃版本，存在后续删除的可能。
  updated	String	参数解释： 版本更新时间。 取值范围： 格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。

  表4 links字段数据结构说明

  名称	参数类型	说明
  href	String	参数解释： 对应该API的URL。 取值范围： 该字段为""。
  rel	String	参数解释： URL类型。 取值范围： 取值为“self”，表示href为本地链接。

• 正常响应样例

  {
    "version": {
      "id": "v1",
      "links": [],
      "status": "DEPRECATED",
      "updated": "2017-02-07T17:34:02Z"
    },
    "versions": {
      "id": "v1",
      "links": [],
      "status": "DEPRECATED",
      "updated": "2017-02-07T17:34:02Z"
    }
  }

• 异常响应

  请参见异常响应结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。