Designate API

这是由 Designate 项目提供的 OpenStack DNS API 的参考文档。

当前 API 版本

支持的 API 版本

无

Designate API 的次要版本是对 API 主要版本的补充，并共享相同的 URL 路径。API 的次要版本更改会在 API 参考文档中，在发生更改的部分中说明。后续的次要版本是相同主要版本的先前版本的超集。

API 状态反映了服务上端点的状态。

  • 当前 表示一个稳定、最新且可能接收未来版本的版本。应优先使用此端点。

  • 支持的 是服务器上可用的稳定版本。但是，它可能不是最新的可用版本，并且将来可能不会更新或被弃用。

  • 已弃用 是仍然可用的稳定版本，但正在弃用，并且将来可能会被删除。

  • 实验性 不是一个稳定版本。此版本正在开发中，或包含以其他方式可能发生更改的功能。

有关 API 状态值和版本信息的更多信息，请参阅 版本发现。

API 版本

显示所有启用的 API 版本

GET
/

列出所有 API 版本

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
405 - 方法不允许

该方法对于此端点和资源无效。
500 - 内部服务器错误

服务出现问题，导致无法满足请求。
503 - 服务不可用

服务现在无法处理请求。

请求

不需要参数

响应参数

名称

入参

类型

描述

id

body

字符串

版本的常用名称。

links

body

对象

指向资源和其他相关资源的链接。当响应被分成页面时，我们将包含一个 next 链接，应跟随该链接以检索所有结果

status

body

字符串

此 API 版本的状态。它可以是以下之一：

  • CURRENT：这是首选的 API 版本。

  • SUPPORTED：这是较旧的，但仍然受支持的 API 版本。

  • DEPRECATED：一个已弃用的 API 版本，计划将其删除。

  • EXPERIMENTAL：此版本正在开发中，或包含以其他方式可能发生更改或删除的功能。

updated_at

body

时间戳

资源上次更新的日期/时间。

响应示例

{
  "versions": [{
    "id": "v2",
    "links": [{
      "href": "http://198.51.100.88/dns/v2",
      "rel": "self"
    }, {
      "href": "https://docs.openstack.org/api-ref/dns",
      "rel": "help"
    }],
    "status": "SUPPORTED",
    "updated": "2022-06-29T00:00:00Z"
  }, {
    "id": "v2.0",
    "links": [{
      "href": "http://198.51.100.88/dns/v2",
      "rel": "self"
    }, {
      "href": "https://docs.openstack.org/api-ref/dns",
      "rel": "help"
    }],
    "status": "CURRENT",
    "updated": "2022-06-29T00:00:00Z"
  }]
}

注意

这只是一个示例输出，并不代表当前可用的 API 版本。