更新时间:2024-05-21 GMT+08:00
分享

查询API所有版本号

功能介绍

查询云审计服务支持的所有API版本号。

URI

GET /

请求参数

响应参数

状态码: 200

表1 响应Body参数

参数

参数类型

描述

versions

Array of Versions objects

描述versions相关对象的列表。

表2 Versions

参数

参数类型

描述

id

String

版本ID(版本号),如v1。

links

Array of LinksBody objects

API的URL地址。

version

String

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

status

String

版本状态,为如下3种: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。

枚举值:

  • CURRENT
  • SUPPORTED
  • DEPRECATED

updated

String

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

min_version

String

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

表3 LinksBody

参数

参数类型

描述

href

String

当前API版本的引用地址。

rel

String

当前API版本和被引用地址的关系。

请求示例

响应示例

状态码: 200

请求正常。

{
  "versions": [
    {
      "id": "v3",
      "links": [
        {
          "href": "https://x.x.x.x/v3/",
          "rel": "self"
        }
      ],
      "min_version": "",
      "status": "CURRENT",
      "updated": "2020-06-30T00:00:00Z",
      "version": ""
    },
    {
      "id": "v2.0",
      "links": [
        {
          "href": "https://x.x.x.x/v2.0/",
          "rel": "self"
        }
      ],
      "min_version": "",
      "status": "DEPRECATED",
      "updated": "2018-09-30T00:00:00Z",
      "version": ""
    },
    {
      "id": "v1.0",
      "links": [
        {
          "href": "https://x.x.x.x/v1.0/",
          "rel": "self"
        }
      ],
      "min_version": "",
      "status": "DEPRECATED",
      "updated": "2018-09-30T00:00:00Z",
      "version": ""
    }
  ]
}

状态码

状态码

描述

200

请求正常。

404

服务器无法找到被请求的资源。

500

请求未完成,服务异常。

错误码

请参见错误码

相关文档