文档首页/ 数据加密服务 DEW/ API参考/ API说明/ 管理加密密钥/ 查询密钥API版本信息/ 查询版本信息列表
更新时间：2024-11-20 GMT+08:00
查看PDF
分享

查询版本信息列表

功能介绍

  • 功能介绍：查询API版本信息列表。

调用方法

请参见如何调用API。

URI

GET /

请求参数

无

响应参数

状态码： 200

表1 响应Body参数

参数

参数类型

描述

versions

Array of ApiVersionDetail objects

描述version 相关对象的列表，详情请参见 versions字段数据结构说明。
表2 ApiVersionDetail

参数

参数类型

描述

id

String

版本ID（版本号），如“v1.0”。

links

Array of ApiLink objects

JSON对象，详情请参见links字段数据结构说明。

version

String

若该版本API支持微版本，则填支持的最大微版本号，如果不支持微版本，则返回空字符串。

status

String

版本状态，包含如下3种：

  • CURRENT：表示该版本为主推版本。

  • SUPPORTED：表示为老版本，但是现在还继续支持。

  • DEPRECATED：表示为废弃版本，存在后续删除的可能。

updated

String

版本发布时间，要求用UTC时间表示。如v1.发布的时间2014-06-28T12:20:21Z。

min_version

String

若该版本API 支持微版本，则填支持的最小微版本号，如果不支持微版本，则返回空字符串。
表3 ApiLink

参数

参数类型

描述

href

String

API的URL地址。

rel

String

默认值self。

状态码： 500

表4 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表5 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 502

表6 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表7 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

状态码： 504

表8 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表9 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码

error_msg

String

错误请求返回的错误信息

请求示例

无

响应示例

状态码： 200

请求已成功

{
  "versions" : [ {
    "min_version" : "",
    "links" : [ {
      "rel" : "self",
      "href" : "https://kms.region_id.domain.com/v1.0/"
    } ],
    "id" : "v1.0",
    "version" : "",
    "updated" : "2016-10-29T02:00:00Z",
    "status" : "CURRENT"
  } ]
}

状态码

状态码

描述

200

请求已成功

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码。

父主题： 查询密钥API版本信息

相关文档