DNS v2 API

区域

区域操作。

POST
/v2/zones

创建区域

创建区域

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

name

body

domainname

区域的 DNS 名称

email

body

字符串

区域的电子邮件。用于区域的 SOA 记录

ttl (可选)

body

整数

区域的 TTL（生存时间）。

description (可选)

body

字符串

此区域的描述

masters (可选)

body

enum

对于辅助区域是必需的。从其获取 DNS 信息的服务器

type (可选)

body

enum

区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域从另一个 DNS 服务器同步。默认为 PRIMARY

attributes (可选)

body

dict

关于此区域和用户希望将区域放置在其中的池的键值对信息。调度程序可以使用此信息将区域放置在正确的池中。

请求示例

{
    "attributes": {
        "tier": "gold", "ha": "true"
    },
    "name": "example.org.",
    "email": "joe@example.org",
    "type": "PRIMARY",
    "ttl": 7200,
    "description": "This is an example zone."
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pool_id

body

uuid

托管此区域的池的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

domainname

区域的 DNS 名称

email

body

字符串

区域的电子邮件。用于区域的 SOA 记录

ttl (可选)

body

整数

区域的 TTL（生存时间）。

串行

body

整数

区域的当前序列号

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

description (可选)

body

字符串

此区域的描述

masters (可选)

body

enum

对于辅助区域是必需的。从其获取 DNS 信息的服务器

type (可选)

body

enum

区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域从另一个 DNS 服务器同步。默认为 PRIMARY

transfered_at

body

enum

对于辅助区域。从主服务器检索更新的上次时间

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

attributes (可选)

body

dict

关于此区域和用户希望将区域放置在其中的池的键值对信息。调度程序可以使用此信息将区域放置在正确的池中。

shared

body

bool

如果区域与另一个项目共享，则为 True。

新增于版本 2.1

links

body

对象

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

响应示例

{
    "id": "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3",
    "pool_id": "572ba08c-d929-4c70-8e42-03824bb24ca2",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "name": "example.org.",
    "email": "joe@example.org",
    "ttl": 7200,
    "serial": 1404757531,
    "status": "ACTIVE",
    "action": "CREATE",
    "description": "This is an example zone.",
    "masters": [],
    "type": "PRIMARY",
    "transferred_at": null,
    "version": 1,
    "created_at": "2014-07-07T18:25:31.275934",
    "updated_at": null,
    "attributes": {
        "tier": "gold", "ha": "true"
    },
    "links": {
      "self": "https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
    }
}
GET
/v2/zones

列出区域

列出所有区域

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

limit (可选)

查询

整数

请求项目页面大小。返回最多限制值数量的项目。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

marker (可选)

查询

字符串

最后一个已查看项目的 ID。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

sort_dir (可选)

查询

字符串

按请求的排序方向对响应进行排序。有效值为 asc（升序）或 desc（降序）。默认值为 asc。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

sort_key (可选)

查询

字符串

按此属性值对响应进行排序。默认值为 id。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

name (可选)

查询

字符串

筛选结果，仅显示名称与筛选器匹配的区域

type (可选)

查询

字符串

筛选结果，仅显示类型与筛选器匹配的区域

email (可选)

查询

字符串

筛选结果，仅显示电子邮件与筛选器匹配的区域

status (可选)

查询

字符串

筛选结果，仅显示状态与筛选器匹配的区域

description (可选)

查询

字符串

筛选结果，仅显示描述与筛选器匹配的区域

ttl (可选)

查询

整数

筛选结果，仅显示 ttl 与筛选器匹配的区域

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pool_id

body

uuid

托管此区域的池的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

domainname

区域的 DNS 名称

email

body

字符串

区域的电子邮件。用于区域的 SOA 记录

ttl (可选)

body

整数

区域的 TTL（生存时间）。

串行

body

整数

区域的当前序列号

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

description (可选)

body

字符串

此区域的描述

masters (可选)

body

enum

对于辅助区域是必需的。从其获取 DNS 信息的服务器

type (可选)

body

enum

区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域从另一个 DNS 服务器同步。默认为 PRIMARY

transfered_at

body

enum

对于辅助区域。从主服务器检索更新的上次时间

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

attributes (可选)

body

dict

关于此区域和用户希望将区域放置在其中的池的键值对信息。调度程序可以使用此信息将区域放置在正确的池中。

shared

body

bool

如果区域与另一个项目共享，则为 True。

新增于版本 2.1

links

body

对象

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

metadata

body

对象

返回与此筛选器匹配的资源的 total_count

响应示例

{
    "zones": [
        {
            "id": "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3",
            "pool_id": "572ba08c-d929-4c70-8e42-03824bb24ca2",
            "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
            "name": "example.org.",
            "email": "joe@example.org",
            "ttl": 7200,
            "serial": 1404757531,
            "status": "ACTIVE",
            "action": "CREATE",
            "description": "This is an example zone.",
            "masters": [],
            "type": "PRIMARY",
            "transferred_at": null,
            "version": 1,
            "created_at": "2014-07-07T18:25:31.275934",
            "updated_at": null,
            "attributes": {
                "tier": "gold", "ha": "true"
            },
            "links": {
              "self": "https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
            }
        }
    ],
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones?limit=1",
        "next": "http://127.0.0.1:9001/v2/zones?limit=1&marker=45fd892d-7a67-4f65-9df0-87273f228d6c"
    },
    "metadata": {
        "total_count": 2
    }
}
GET
/v2/zones/{zone_id}

显示区域

显示区域

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pool_id

body

uuid

托管此区域的池的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

domainname

区域的 DNS 名称

email

body

字符串

区域的电子邮件。用于区域的 SOA 记录

ttl (可选)

body

整数

区域的 TTL（生存时间）。

串行

body

整数

区域的当前序列号

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

description (可选)

body

字符串

此区域的描述

masters (可选)

body

enum

对于辅助区域是必需的。从其获取 DNS 信息的服务器

type (可选)

body

enum

区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域从另一个 DNS 服务器同步。默认为 PRIMARY

transfered_at

body

enum

对于辅助区域。从主服务器检索更新的上次时间

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

attributes (可选)

body

dict

关于此区域和用户希望将区域放置在其中的池的键值对信息。调度程序可以使用此信息将区域放置在正确的池中。

shared

body

bool

如果区域与另一个项目共享，则为 True。

新增于版本 2.1

links

body

对象

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

响应示例

{
    "id": "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3",
    "pool_id": "572ba08c-d929-4c70-8e42-03824bb24ca2",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "name": "example.org.",
    "email": "joe@example.org",
    "ttl": 7200,
    "serial": 1404757531,
    "status": "ACTIVE",
    "action": "CREATE",
    "description": "This is an example zone.",
    "masters": [],
    "type": "PRIMARY",
    "transferred_at": null,
    "version": 1,
    "created_at": "2014-07-07T18:25:31.275934",
    "updated_at": null,
    "attributes": {
        "tier": "gold", "ha": "true"
    },
    "links": {
      "self": "https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
    }
}
GET
/v2/zones/{zone_id}/nameservers

获取区域的名称服务器

显示区域的名称服务器

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

hostname

body

hostname

名称服务器的主机名，区域应委托给它

priority

body

整数

名称服务器的优先级。这用于确定名称服务器列表的顺序，以及在区域的 SOA 记录中使用哪个服务器。

响应示例

{
    "nameservers": [
        {
            "hostname": "ns1.example.com.",
            "priority": 10
        }
    ]
}
PATCH
/v2/zones/{zone_id}

更新区域

更新现有区域的属性。

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

email (可选)

body

字符串

区域的电子邮件。用于区域的 SOA 记录

ttl (可选)

body

整数

区域的 TTL（生存时间）。

description (可选)

body

字符串

此区域的描述

请求示例

{
    "ttl": 600,
    "description": "Updated Description"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pool_id

body

uuid

托管此区域的池的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

domainname

区域的 DNS 名称

email

body

字符串

区域的电子邮件。用于区域的 SOA 记录

ttl (可选)

body

整数

区域的 TTL（生存时间）。

串行

body

整数

区域的当前序列号

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

description (可选)

body

字符串

此区域的描述

masters (可选)

body

enum

对于辅助区域是必需的。从其获取 DNS 信息的服务器

type (可选)

body

enum

区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域从另一个 DNS 服务器同步。默认为 PRIMARY

transfered_at

body

enum

对于辅助区域。从主服务器检索更新的上次时间

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

attributes (可选)

body

dict

关于此区域和用户希望将区域放置在其中的池的键值对信息。调度程序可以使用此信息将区域放置在正确的池中。

shared

body

bool

如果区域与另一个项目共享，则为 True。

新增于版本 2.1

links

body

对象

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

响应示例

{
    "id": "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3",
    "pool_id": "572ba08c-d929-4c70-8e42-03824bb24ca2",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "name": "example.org.",
    "email": "joe@example.org",
    "ttl": 600,
    "serial": 1404757531,
    "status": "PENDING",
    "action": "UPDATE",
    "description": "Updated Description",
    "masters": [],
    "type": "PRIMARY",
    "transferred_at": null,
    "version": 1,
    "created_at": "2014-07-07T18:25:31.275934",
    "updated_at": null,
    "attributes": {
        "tier": "gold", "ha": "true"
    },
    "links": {
      "self": "https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
    }
}
DELETE
/v2/zones/{zone_id}

删除区域

删除区域

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

x-designate-hard-delete (可选)

标头

bool

如果启用，这将删除后端上的区域资源（即文件）。

x-designate-delete-shares (可选)

标头

bool

如果启用，这将删除与资源关联的共享。

新增于版本 2.1

zone_id

路径

uuid

区域的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pool_id

body

uuid

托管此区域的池的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

domainname

区域的 DNS 名称

email

body

字符串

区域的电子邮件。用于区域的 SOA 记录

ttl (可选)

body

整数

区域的 TTL（生存时间）。

串行

body

整数

区域的当前序列号

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

description (可选)

body

字符串

此区域的描述

masters (可选)

body

enum

对于辅助区域是必需的。从其获取 DNS 信息的服务器

type (可选)

body

enum

区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域从另一个 DNS 服务器同步。默认为 PRIMARY

transfered_at

body

enum

对于辅助区域。从主服务器检索更新的上次时间

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

attributes (可选)

body

dict

关于此区域和用户希望将区域放置在其中的池的键值对信息。调度程序可以使用此信息将区域放置在正确的池中。

shared

body

bool

如果区域与另一个项目共享，则为 True。

新增于版本 2.1

links

body

对象

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

响应示例

{
    "id": "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3",
    "pool_id": "572ba08c-d929-4c70-8e42-03824bb24ca2",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "name": "example.org.",
    "email": "joe@example.org",
    "ttl": 600,
    "serial": 1404757531,
    "status": "PENDING",
    "action": "DELETE",
    "description": "Updated Description",
    "masters": [],
    "type": "PRIMARY",
    "transferred_at": null,
    "version": 1,
    "created_at": "2014-07-07T18:25:31.275934",
    "updated_at": null,
    "links": {
      "self": "https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
    }
}

区域导入

区域导入是一个异步操作，并且有不同的端点来查看导入的状态和进度

POST
/v2/zones/tasks/imports

创建区域导入

导入区域。

注意

此 POST 不应具有正文，并且 content-type 应为 text/dns

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域导入的 ID

status

body

uuid

区域导入的当前状态

zone_id (可选)

body

uuid

此导入创建的区域的 ID

message (可选)

body

uuid

关于导入当前状态的消息

project_id

body

uuid

拥有该资源的项目的 ID

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

响应示例

{
    "status": "PENDING",
    "zone_id": null,
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/imports/074e805e-fe87-4cbb-b10b-21a06e215d41"
    },
    "created_at": "2015-05-08T15:43:42.000000",
    "updated_at": null,
    "version": 1,
    "message": null,
    "project_id": "1",
    "id": "074e805e-fe87-4cbb-b10b-21a06e215d41"
}
GET
/v2/zones/tasks/imports

列出所有区域导入

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id (可选)

查询

uuid

筛选结果，仅显示 zone_id 与筛选器匹配的 zone_imports

message (可选)

查询

字符串

筛选结果，仅显示 message 与筛选器匹配的 zone_imports

status (可选)

查询

字符串

筛选结果，仅显示 status 与筛选器匹配的 zone_imports

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域导入的 ID

status

body

uuid

区域导入的当前状态

zone_id (可选)

body

uuid

此导入创建的区域的 ID

project_id

body

uuid

拥有该资源的项目的 ID

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

links

body

对象

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

metadata

body

对象

返回与此筛选器匹配的资源的 total_count

响应示例

{
     "imports": [
         {
            "status": "COMPLETE",
            "zone_id": "047888ee-e9dd-4c08-8b44-ab2e879e01bd",
            "links": {
                "self": "http://127.0.0.1:9001/v2/zones/tasks/imports/0436a86e-ffc1-4d38-82a7-d75170fcd2a9",
                "href": "http://127.0.0.1:9001/v2/zones/047888ee-e9dd-4c08-8b44-ab2e879e01bd"
            },
            "created_at": "2016-04-05T06:03:06.000000",
            "updated_at": "2016-04-05T06:03:06.000000",
            "version": 2,
            "message": "example.com. imported",
            "project_id": "1de6e2fdc22342d3bef6340c7b70f497",
            "id": "0436a86e-ffc1-4d38-82a7-d75170fcd2a9"
        },
        {
            "status": "COMPLETE",
            "zone_id": "68a17870-7f81-470a-b5e9-2753460fd6dc",
            "links": {
                "self": "http://127.0.0.1:9001/v2/zones/tasks/imports/f0aa4ac1-f975-46a4-b417-339acd1ea8e3",
                "href": "http://127.0.0.1:9001/v2/zones/68a17870-7f81-470a-b5e9-2753460fd6dc"
            },
            "created_at": "2016-04-05T06:06:26.000000",
            "updated_at": "2016-04-05T06:06:26.000000",
            "version": 2,
            "message": "temp.org. imported",
            "project_id": "1de6e2fdc22342d3bef6340c7b70f497",
            "id": "f0aa4ac1-f975-46a4-b417-339acd1ea8e3"
        }
     ],
     "links": {
         "self": "http://127.0.0.1:9001/v2/zones/tasks/imports"
     },
     "metadata": {
         "total_count": 2
     }
}
GET
/v2/zones/tasks/imports/{zone_import_id}

显示区域导入

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

Request

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_import_id

路径

uuid

此区域导入的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域导入的 ID

status

body

uuid

区域导入的当前状态

zone_id (可选)

body

uuid

此导入创建的区域的 ID

project_id

body

uuid

拥有该资源的项目的 ID

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

links

body

对象

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

响应示例

{
    "status": "COMPLETE",
    "zone_id": "6625198b-d67d-47dc-8d29-f90bd60f3ac4",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/imports/074e805e-fe87-4cbb-b10b-21a06e215d41",
        "href": "http://127.0.0.1:9001/v2/zones/6625198b-d67d-47dc-8d29-f90bd60f3ac4"
    },
    "created_at": "2015-05-08T15:43:42.000000",
    "updated_at": "2015-05-08T15:43:42.000000",
    "version": 2,
    "message": "example.com. imported",
    "project_id": "noauth-project",
    "id": "074e805e-fe87-4cbb-b10b-21a06e215d41"
}
DELETE
/v2/zones/tasks/imports/{zone_import_id}

删除区域导入

这将仅删除区域导入的记录，而不是导入的区域。

必须从区域删除 API 删除区域

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_import_id

路径

uuid

此区域导入的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

区域导出

区域导出可以是一个异步操作，并且有不同的端点来查看状态和进度

POST
/v2/zones/{zone_id}/tasks/export

创建区域导出

导出区域。

注意

此 POST 不应具有正文

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域导出的 ID

location (可选)

body

字符串

导出的区域发布到的位置。当前有一个放置选项可用 - designate。这将显示为 designate://<url>。随着添加更多驱动程序，这将扩展到包括 swift - 这将通过 location 设置为 swift://<region>/<container>/<file> 如果操作员实现不同的数据存储，这也允许为 http://<url> 当区域导出完成时，将更新位置，并且导出的区域文件将在指定位置可用。

status

body

字符串

区域导出的当前状态

zone_id (可选)

body

uuid

正在导出的区域的 ID

message (可选)

body

uuid

关于导出当前状态的消息

project_id

body

uuid

拥有该资源的项目的 ID

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

响应示例

{
    "status": "PENDING",
    "zone_id": "074e805e-fe87-4cbb-b10b-21a06e215d41",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/exports/8ec17fe1-d1f9-41b4-aa98-4eeb4c27b720"
    },
    "created_at": "2015-08-27T20:57:03.000000",
    "updated_at": null,
    "version": 1,
    "location": null,
    "message": null,
    "project_id": "1",
    "id": "8ec17fe1-d1f9-41b4-aa98-4eeb4c27b720"
}
GET
/v2/zones/tasks/exports

列出所有区域导出

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id (可选)

查询

uuid

筛选结果，仅显示 zone_exports 的 zone_id 与筛选器匹配

message (可选)

查询

字符串

筛选结果，仅显示 zone_exports 的 message 与筛选器匹配

status (可选)

查询

字符串

筛选结果，仅显示 zone_exports 的 status 与筛选器匹配

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域导出的 ID

location (可选)

body

字符串

导出的区域发布到的位置。当前有一个放置选项可用 - designate。这将显示为 designate://<url>。随着添加更多驱动程序，这将扩展到包括 swift - 这将通过 location 设置为 swift://<region>/<container>/<file> 如果操作员实现不同的数据存储，这也允许为 http://<url> 当区域导出完成时，将更新位置，并且导出的区域文件将在指定位置可用。

status

body

字符串

区域导出的当前状态

zone_id (可选)

body

uuid

正在导出的区域的 ID

project_id

body

uuid

拥有该资源的项目的 ID

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

links

body

对象

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

metadata

body

对象

返回与此筛选器匹配的资源的 total_count

响应示例

{

    "exports": [
        {
            "status": "COMPLETE",
            "zone_id": "17a8d6b3-6ace-4857-b113-a707c5f975b1",
            "links": {
                "self": "http://127.0.0.1:9001/v2/zones/tasks/exports/204be410-0a9c-44b8-839e-bc4df3bb0d9a",
                "export": "http://127.0.0.1:9001/v2/zones/tasks/exports/204be410-0a9c-44b8-839e-bc4df3bb0d9a/export"
            },
            "created_at": "2016-04-04T01:53:29.000000",
            "updated_at": "2016-04-04T01:53:29.000000",
            "version": 2,
            "location": "designate://v2/zones/tasks/exports/204be410-0a9c-44b8-839e-bc4df3bb0d9a/export",
            "message": null,
            "project_id": "1de6e2fdc22342d3bef6340c7b70f497",
            "id": "204be410-0a9c-44b8-839e-bc4df3bb0d9a"
        }
    ],
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/exports"
    },
    "metadata": {
        "total_count": 1
    }
}
GET
/v2/zones/tasks/exports/{zone_export_id}

显示区域导出信息

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_export_id

路径

uuid

此区域导出的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域导出的 ID

location (可选)

body

字符串

导出的区域发布到的位置。当前有一个放置选项可用 - designate。这将显示为 designate://<url>。随着添加更多驱动程序，这将扩展到包括 swift - 这将通过 location 设置为 swift://<region>/<container>/<file> 如果操作员实现不同的数据存储，这也允许为 http://<url> 当区域导出完成时，将更新位置，并且导出的区域文件将在指定位置可用。

status

body

字符串

区域导出的当前状态

zone_id (可选)

body

uuid

正在导出的区域的 ID

project_id

body

uuid

拥有该资源的项目的 ID

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

links

body

对象

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

响应示例

{
    "status": "COMPLETE",
    "zone_id": "6625198b-d67d-47dc-8d29-f90bd60f3ac4",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/exports/8ec17fe1-d1f9-41b4-aa98-4eeb4c27b720",
        "export": "http://127.0.0.1:9001/v2/zones/tasks/exports/8ec17fe1-d1f9-41b4-aa98-4eeb4c27b720/export"
    },
    "created_at": "2015-08-27T20:57:03.000000",
    "updated_at": "2015-08-27T20:57:03.000000",
    "version": 2,
    "location": "designate://v2/zones/tasks/exports/8ec17fe1-d1f9-41b4-aa98-4eeb4c27b720/export",
    "message": null,
    "project_id": "noauth-project",
    "id": "8ec17fe1-d1f9-41b4-aa98-4eeb4c27b720"
}
GET
/v2/zones/tasks/exports/{zone_export_id}/export

从 Designate 数据存储中检索区域导出

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

注意

此端点将发送一个具有 text/dns content-type 的响应。如果客户端未包含 Accepts: text/dns 标头，则请求将被拒绝。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_export_id

路径

uuid

此区域导出的 ID

accepts

标头

字符串

客户端将接受的 Content-Type。此端点将发送一个具有 text/dns content-type 的响应。如果客户端未包含 Accepts: text/dns 标头

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

响应示例

$ORIGIN example.com.
$TTL 42

example.com. IN SOA ns.designate.com. nsadmin.example.com. (
    1394213803 ; serial
    3600 ; refresh
    600 ; retry
    86400 ; expire
    3600 ; minimum
)


example.com. IN NS ns.designate.com.


example.com.  IN MX 10 mail.example.com.
ns.example.com.  IN A  10.0.0.1
mail.example.com.  IN A  10.0.0.2
DELETE
/v2/zones/tasks/exports/{zone_export_id}

删除区域导出

这将仅删除区域导出的记录，而不是导出的区域。

必须从区域删除 API 删除区域

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_export_id

路径

uuid

此区域导出的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

区域任务

区域任务。

POST
/v2/zones/{zone_id}/tasks/abandon

放弃区域

放弃区域。

这会从 designate 数据库中删除区域，而不会从后端删除它。

注意

此 POST 不应具有正文。

警告

这是一个潜在危险的操作，仅在需要时才应使用

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID
POST
/v2/zones/{zone_id}/tasks/xfr

手动触发辅助区域的更新

触发来自上游 DNS 服务器的新 XFR

这将导致 designate 查询名称服务器，如果 Designate 中的版本已过时，则导入新版本。

如果上游服务器未能向 Designate 发送通知，这将很有用

注意

此 POST 不应具有正文。

重要提示

仅对 SECONDARY 区域有用。

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID
POST
/v2/zones/{zone_id}/tasks/pool_move

池移动区域

将区域移动到另一个池。

这将把区域从现有的 designate 池移动到指定的目标池。如果管理员未指定池，designate 将自行确定合适的池并将区域移动到该池。

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

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

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

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

pool_id (可选)

body

uuid

要将区域移动到的目标池 ID

请求示例

{
    "pool_id": "8e6f1c59-15e7-4a14-8640-8d5e07f95b10"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

共享区域

共享区域操作。

GET
/v2/zones/{zone_id}/shares/{zone_share_id}

显示区域共享

显示单个区域共享。

新增于版本 2.1

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

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

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

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

zone_share_id

路径

uuid

区域共享的 ID。

新增于版本 2.1

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

zone_id

body

uuid

正在共享的区域的 ID。

新增于版本 2.1

project_id

body

uuid

拥有该资源的项目的 ID

target_project_id

body

字符串

将共享区域的项目 ID。

新增于版本 2.1

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "id": "fd40b017-bf97-461c-8d30-d4e922b28edd",
    "zone_id": "a3365b47-ee93-43ad-9a60-2b2ca96b1898",
    "project_id": "16ade46c85a1435bb86d9138d37da57e",
    "target_project_id": "232e37df46af42089710e2ae39111c2f",
    "created_at": "2022-11-30T22:20:27.000000",
    "updated_at": null,
    "links": {
        "self": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898/shares/fd40b017-bf97-461c-8d30-d4e922b28edd",
        "zone": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898"
    }
}
GET
/v2/zones/{zone_id}/shares

获取所有共享区域

列出所有区域共享。

新增于版本 2.1

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

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

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

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

target_project_id (可选)

查询

字符串

根据 target_project_id 过滤结果，仅显示匹配的资源

新增于版本 2.1

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

zone_id

body

uuid

正在共享的区域的 ID。

新增于版本 2.1

project_id

body

uuid

拥有该资源的项目的 ID

target_project_id

body

字符串

将共享区域的项目 ID。

新增于版本 2.1

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "shared_zones": [{
        "id": "4495ffbb-b7d1-43e0-9423-f0a4172e5f9e",
        "zone_id": "a3365b47-ee93-43ad-9a60-2b2ca96b1898",
        "project_id": "16ade46c85a1435bb86d9138d37da57e",
        "target_project_id": "232e37df46af42089710e2ae39111c2f",
        "created_at": "2022-12-01T23:02:49.000000",
        "updated_at": null,
        "links": {
            "self": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898/shares/4495ffbb-b7d1-43e0-9423-f0a4172e5f9e",
            "zone": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898"
        }
    }, {
        "id": "1f278d08-2f6a-462a-bb49-21a4f6e6d32b",
        "zone_id": "a3365b47-ee93-43ad-9a60-2b2ca96b1898",
        "project_id": "16ade46c85a1435bb86d9138d37da57e",
        "target_project_id": "86d78e93698e4b06aad4f62e04afb4c1",
        "created_at": "2022-12-02T01:51:48.000000",
        "updated_at": null,
        "links": {
            "self": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898/shares/1f278d08-2f6a-462a-bb49-21a4f6e6d32b",
            "zone": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898"
        }
    }],
    "links": {
        "self": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898/shares"
    }
}
POST
/v2/zones/{zone_id}/shares

创建共享区域

将区域共享给另一个项目。

新增于版本 2.1

成功

代码

原因
201 - 已创建

请求已完成，并创建了新资源。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
500 - 内部服务器错误

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

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

target_project_id

body

字符串

将共享区域的项目 ID。

新增于版本 2.1

请求示例

{
    "target_project_id": "232e37df46af42089710e2ae39111c2f"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

zone_id

body

uuid

正在共享的区域的 ID。

新增于版本 2.1

project_id

body

uuid

拥有该资源的项目的 ID

target_project_id

body

字符串

将共享区域的项目 ID。

新增于版本 2.1

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "id": "fd40b017-bf97-461c-8d30-d4e922b28edd",
    "zone_id": "a3365b47-ee93-43ad-9a60-2b2ca96b1898",
    "project_id": "16ade46c85a1435bb86d9138d37da57e",
    "target_project_id": "232e37df46af42089710e2ae39111c2f",
    "created_at": "2022-11-30T22:20:27.000000",
    "updated_at": null,
    "links": {
        "self": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898/shares/fd40b017-bf97-461c-8d30-d4e922b28edd",
        "zone": "http://127.0.0.1:60053/v2/zones/a3365b47-ee93-43ad-9a60-2b2ca96b1898"
    }
}
DELETE
/v2/zones/{zone_id}/shares/{zone_share_id}

删除区域共享

删除区域共享。

新增于版本 2.1

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

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

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

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

zone_share_id

路径

uuid

区域共享的 ID。

新增于版本 2.1

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

区域所有权转移 - 请求

Designate 允许用户在项目之间转移区域的所有权。

传统方法是创建一个 zone_transfer_request，通过非同步方式将密钥和 ID 告知目标所有者，然后他们使用这些信息创建一个 zone_transfer_accept，这将转移该区域的所有权到该项目。

POST
/v2/zones/{zone_id}/tasks/transfer_requests

创建区域转移请求

这会创建一个将区域转移到不同项目的请求。如果提供了 project_id 参数，则可以将请求限定为单个项目。

注意

此 POST 请求可以没有请求体。

成功

代码

原因
201 - 已创建

请求已完成，并创建了新资源。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

target_project_id (可选)

body

字符串

请求将限制到的项目 ID。不允许其他项目接受此请求。

description

body

字符串

资源的描述。仅在 API / Horizon 中显示

请求示例

{
    "project_id": "1"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域转移请求的 ID

project_id

body

uuid

拥有该资源的项目的 ID

description

body

字符串

资源的描述。仅在 API / Horizon 中显示

status

body

字符串

区域转移请求的当前状态

zone_id

body

uuid

正在导出的区域的 ID

zone_name

body

字符串

正在导出区域的名称

key

body

字符串

用于区域转移接受过程的密钥。仅向创建者显示，必须通过非同步方式进行沟通。

target_project_id (可选)

body

字符串

请求将限制到的项目 ID。不允许其他项目接受此请求。

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

响应示例

{
    "created_at": "2014-07-17T20:34:40.882579",
    "description": null,
    "id": "f2ad17b5-807a-423f-a991-e06236c247be",
    "key": "9Z2R50Y0",
    "project_id": "1",
    "status": "ACTIVE",
    "target_project_id": "123456",
    "updated_at": null,
    "zone_id": "6b78734a-aef1-45cd-9708-8eb3c2d26ff8",
    "zone_name": "qa.dev.example.com.",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_requests/f2ad17b5-807a-423f-a991-e06236c247be"
    }
}
GET
/v2/zones/tasks/transfer_requests

列出区域传输请求

这将列出所有传出的请求，以及任何已限定到您项目的传入请求。

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

status (可选)

查询

字符串

根据 status 过滤结果，仅显示匹配的 zone_transfer_requests

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域转移请求的 ID

project_id

body

uuid

拥有该资源的项目的 ID

description

body

字符串

资源的描述。仅在 API / Horizon 中显示

status

body

字符串

区域转移请求的当前状态

zone_id

body

uuid

正在导出的区域的 ID

zone_name

body

字符串

正在导出区域的名称

key

body

字符串

用于区域转移接受过程的密钥。仅向创建者显示，必须通过非同步方式进行沟通。

target_project_id (可选)

body

字符串

请求将限制到的项目 ID。不允许其他项目接受此请求。

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

响应示例

{
    "transfer_requests": [
        {
            "created_at": "2014-07-17T20:34:40.882579",
            "description": "This was created by the requesting project",
            "id": "f2ad17b5-807a-423f-a991-e06236c247be",
            "key": "9Z2R50Y0",
            "project_id": "1",
            "status": "ACTIVE",
            "target_project_id": "123456",
            "updated_at": null,
            "zone_id": "6b78734a-aef1-45cd-9708-8eb3c2d26ff8",
            "zone_name": "qa.dev.example.com.",
            "links": {
                "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_requests/f2ad17b5-807a-423f-a991-e06236c247be"
            }
        },
        {
            "description": "This is scoped to the requesting project",
            "id": "efd2d720-b0c4-43d4-99f7-d9b53e08860d",
            "zone_id": "2c4d5e37-f823-4bee-9859-031cb44f80e7",
            "zone_name": "subdomain.example.com.",
            "status": "ACTIVE",
            "links": {
                "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_requests/efd2d720-b0c4-43d4-99f7-d9b53e08860d"
            }
        }
    ],
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_requests"
    }
}
GET
/v2/zones/tasks/transfer_requests/{zone_transfer_request_id}

显示区域转移请求

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_transfer_request_id

路径

uuid

此区域转移请求的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域转移请求的 ID

project_id

body

uuid

拥有该资源的项目的 ID

description

body

字符串

资源的描述。仅在 API / Horizon 中显示

status

body

字符串

区域转移请求的当前状态

zone_id

body

uuid

正在导出的区域的 ID

zone_name

body

字符串

正在导出区域的名称

key

body

字符串

用于区域转移接受过程的密钥。仅向创建者显示，必须通过非同步方式进行沟通。

target_project_id (可选)

body

字符串

请求将限制到的项目 ID。不允许其他项目接受此请求。

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

响应示例

{
    "description": "This is scoped to the requesting project",
    "id": "efd2d720-b0c4-43d4-99f7-d9b53e08860d",
    "zone_id": "2c4d5e37-f823-4bee-9859-031cb44f80e7",
    "zone_name": "subdomain.example.com.",
    "status": "ACTIVE",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_requests/efd2d720-b0c4-43d4-99f7-d9b53e08860d"
    }
}
PATCH
/v2/zones/tasks/transfer_requests/{zone_transfer_request_id}

更新区域传输请求

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_transfer_request_id

路径

uuid

此区域转移请求的 ID

target_project_id (可选)

body

字符串

请求将限制到的项目 ID。不允许其他项目接受此请求。

description

body

字符串

资源的描述。仅在 API / Horizon 中显示

请求示例

{
    "description": "This is scoped to the new project",
    "target_project_id": "987654"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域转移请求的 ID

project_id

body

uuid

拥有该资源的项目的 ID

description

body

字符串

资源的描述。仅在 API / Horizon 中显示

status

body

字符串

区域转移请求的当前状态

zone_id

body

uuid

正在导出的区域的 ID

zone_name

body

字符串

正在导出区域的名称

key

body

字符串

用于区域转移接受过程的密钥。仅向创建者显示，必须通过非同步方式进行沟通。

target_project_id (可选)

body

字符串

请求将限制到的项目 ID。不允许其他项目接受此请求。

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

版本

body

整数

资源的版本

响应示例

{
    "description": "This is scoped to the new project",
    "target_project_id": "987654",
    "id": "efd2d720-b0c4-43d4-99f7-d9b53e08860d",
    "zone_id": "2c4d5e37-f823-4bee-9859-031cb44f80e7",
    "zone_name": "subdomain.example.com.",
    "status": "ACTIVE",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_requests/efd2d720-b0c4-43d4-99f7-d9b53e08860d"
    }
}
DELETE
/v2/zones/tasks/transfer_requests/{zone_transfer_request_id}

删除区域传输请求

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_transfer_request_id

路径

uuid

此区域转移请求的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

区域所有权转移 - 接受

Designate 允许用户在项目之间转移区域的所有权。

对于最后一步，接收项目必须使用 transfer_accepts API 接受新的区域。

POST
/v2/zones/tasks/transfer_accepts

创建区域转移接受

这接受了所有权转移的请求

成功

代码

原因
201 - 已创建

请求已完成，并创建了新资源。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

key

body

字符串

用于区域转移接受过程的密钥。仅向创建者显示，必须通过非同步方式进行沟通。

zone_transfer_request_id

body

uuid

此区域转移请求的 ID

请求示例

{
    "key":"FUGXMZ5N",
    "zone_transfer_request_id":"794fdf58-6e1d-41da-8b2d-16b6d10c8827"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域转移接受的 ID

status

body

字符串

区域转移请求的当前状态

project_id

body

uuid

拥有该资源的项目的 ID

zone_id

body

uuid

此区域转移请求的 ID

key

body

字符串

用于区域转移接受过程的密钥。仅向创建者显示，必须通过非同步方式进行沟通。

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

zone_transfer_request_id

body

uuid

此区域转移请求的 ID

links

body

对象

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

响应示例

{
    "status": "COMPLETE",
    "zone_id": "b4542f5a-f1ea-4ec1-b850-52db9dc3f465",
    "links": {
        "self": "http://10.0.4.46:9001/v2/zones/tasks/transfer_accepts/fe8c30f5-42f6-4af1-8cbf-e31a810d8c33",
        "zone": "http://10.0.4.46:9001/v2/zones/b4542f5a-f1ea-4ec1-b850-52db9dc3f465"
    },
    "created_at": "2016-06-22 06:13:55",
    "updated_at": "null",
    "key": "FUGXMZ5N",
    "project_id": "2e43de7ce3504a8fb90a45382532c37e",
    "id": "fe8c30f5-42f6-4af1-8cbf-e31a810d8c33",
    "zone_transfer_request_id": "794fdf58-6e1d-41da-8b2d-16b6d10c8827"
}
GET
/v2/zones/tasks/transfer_requests/{zone_transfer_accept_id}

获取区域转移接受

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_transfer_accept_id

路径

uuid

此区域转移接受的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域转移接受的 ID

status

body

字符串

区域转移请求的当前状态

project_id

body

uuid

拥有该资源的项目的 ID

zone_id

body

uuid

此区域转移请求的 ID

key

body

字符串

用于区域转移接受过程的密钥。仅向创建者显示，必须通过非同步方式进行沟通。

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

zone_transfer_request_id

body

uuid

此区域转移请求的 ID

links

body

对象

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

响应示例

{
    "status": "COMPLETE",
    "zone_id": "b4542f5a-f1ea-4ec1-b850-52db9dc3f465",
    "links": {
        "self": "http://10.0.4.46:9001/v2/zones/tasks/transfer_accepts/fe8c30f5-42f6-4af1-8cbf-e31a810d8c33",
        "zone": "http://10.0.4.46:9001/v2/zones/b4542f5a-f1ea-4ec1-b850-52db9dc3f465"
    },
    "created_at": "2016-06-22 06:13:55",
    "updated_at": "null",
    "key": "FUGXMZ5N",
    "project_id": "2e43de7ce3504a8fb90a45382532c37e",
    "id": "fe8c30f5-42f6-4af1-8cbf-e31a810d8c33",
    "zone_transfer_request_id": "794fdf58-6e1d-41da-8b2d-16b6d10c8827"
}
GET
/v2/zones/tasks/transfer_accepts

列出区域传输接受

这将列出您接受的所有所有权转移。

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

status (可选)

查询

字符串

根据 status 过滤结果，仅显示匹配的 zone_transfer_accepts

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

此区域转移接受的 ID

project_id

body

uuid

拥有该资源的项目的 ID

status

body

字符串

区域转移请求的当前状态

zone_id

body

uuid

此区域转移请求的 ID

key

body

字符串

用于区域转移接受过程的密钥。仅向创建者显示，必须通过非同步方式进行沟通。

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

zone_transfer_request_id

body

uuid

此区域转移请求的 ID

links

body

对象

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

metadata

body

对象

返回与此筛选器匹配的资源的 total_count

响应示例

{
    "metadata": {
         "total_count": 2
     },
     "links": {
         "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_accepts"
     },
     "transfer_accepts": [{
         "status": "COMPLETE",
         "zone_id": "8db93d1a-59e3-4143-a393-5821abea0a46",
         "links": {
             "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_accepts/afb4222b-18b3-44b3-9f54-e0dfdba1be44",
             "zone": "http://127.0.0.1:9001/v2/zones/8db93d1a-59e3-4143-a393-5821abea0a46"
         },
         "created_at": "2016-06-01 05:35:35",
         "updated_at": "2016-06-01 05:35:35",
         "key": null,
         "project_id": "85604ecfb5334b50bd40ca53fc1d710f",
         "id": "afb4222b-18b3-44b3-9f54-e0dfdba1be44",
         "zone_transfer_request_id": "d223f7ef-77a6-459e-abd3-b4dbc97338e7"
       },
       {
         "status": "COMPLETE",
         "zone_id": "925bfc45-8901-4aca-aa12-18afaf0879e2",
         "links": {
             "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_accepts/ecbc7091-c498-4ec4-9893-68b06297fe50",
             "zone": "http://127.0.0.1:9001/v2/zones/925bfc45-8901-4aca-aa12-18afaf0879e2"
         },
         "created_at": "2016-06-01 10:06:36",
         "updated_at": "2016-06-01 10:06:37",
         "key": null,
         "project_id": "85604ecfb5334b50bd40ca53fc1d710f",
         "id": "ecbc7091-c498-4ec4-9893-68b06297fe50",
         "zone_transfer_request_id": "94cf9bd3-4137-430b-bf75-4e690430258c"
       }
     ]
}

记录集

记录集操作。

POST
/v2/zones/{zone_id}/recordsets

创建记录集

在区域中创建一个记录集

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

name

body

hostname

记录集的 DNS 名称

zone_id

路径

uuid

区域的 ID

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

records

body

字符串

此记录集的数据列表。每个条目在 Designate 中将是一个单独的记录。这些条目应符合记录类型的 DNS 规范 - 例如，A 记录必须是 IPv4 地址，CNAME 记录必须是主机名。

请求示例

{
  "name" : "example.org.",
  "description" : "This is an example record set.",
  "type" : "A",
  "ttl" : 3600,
  "records" : [
      "10.1.0.2"
  ]
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "description": "This is an example record set.",
    "links": {
        "self": "https://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets/f7b10e9b-0cae-4a91-b162-562bc6096648"
    },
    "updated_at": null,
    "records": [
        "10.1.0.2"
    ],
    "ttl": 3600,
    "id": "f7b10e9b-0cae-4a91-b162-562bc6096648",
    "name": "example.org.",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "zone_id": "2150b1bf-dee2-4221-9d85-11f7886fb15f",
    "zone_name": "example.com.",
    "created_at": "2014-10-24T19:59:44.000000",
    "version": 1,
    "type": "A",
    "status": "PENDING",
    "action": "CREATE"
}
GET
/v2/zones/{zone_id}/recordsets

列出区域中的记录集

这将列出区域中的所有记录集

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

limit (可选)

查询

整数

请求项目页面大小。返回最多限制值数量的项目。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

marker (可选)

查询

字符串

最后一个已查看项目的 ID。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

sort_dir (可选)

查询

字符串

按请求的排序方向对响应进行排序。有效值为 asc（升序）或 desc（降序）。默认值为 asc。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

sort_key (可选)

查询

字符串

按此属性值对响应进行排序。默认值为 id。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

name (可选)

查询

字符串

根据名称过滤结果，仅显示匹配的记录集

type (可选)

查询

字符串

根据类型过滤结果，仅显示匹配的记录集

ttl (可选)

查询

字符串

根据 ttl 过滤结果，仅显示匹配的记录集

data (可选)

查询

字符串

根据数据过滤结果，仅显示记录中包含匹配数据的记录集

status (可选)

查询

字符串

根据状态过滤结果，仅显示匹配的记录集

description (可选)

查询

字符串

根据描述过滤结果，仅显示匹配的记录集

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

metadata

body

对象

返回与此筛选器匹配的资源的 total_count

响应示例

{
    "recordsets": [
        {
            "description": "This is an example record set.",
            "links": {
                "self": "https://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets/f7b10e9b-0cae-4a91-b162-562bc6096648"
            },
            "updated_at": null,
            "records": [
                "10.1.0.2"
            ],
            "ttl": 3600,
            "id": "f7b10e9b-0cae-4a91-b162-562bc6096648",
            "name": "example.org.",
            "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
            "zone_id": "2150b1bf-dee2-4221-9d85-11f7886fb15f",
            "zone_name": "example.com.",
            "created_at": "2014-10-24T19:59:44.000000",
            "version": 1,
            "type": "A",
            "status": "PENDING",
            "action": "CREATE"
        }
    ],
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets?limit=1",
        "next": "http://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets?limit=1&marker=45fd892d-7a67-4f65-9df0-87273f228d6c"
    },
    "metadata": {
        "total_count": 2
    }
}
GET
/v2/recordsets

列出项目拥有的所有记录集

这将列出 Designate 中项目拥有的所有记录集

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

limit (可选)

查询

整数

请求项目页面大小。返回最多限制值数量的项目。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

marker (可选)

查询

字符串

最后一个已查看项目的 ID。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

sort_dir (可选)

查询

字符串

按请求的排序方向对响应进行排序。有效值为 asc（升序）或 desc（降序）。默认值为 asc。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

sort_key (可选)

查询

字符串

按此属性值对响应进行排序。默认值为 id。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

name (可选)

查询

字符串

根据名称过滤结果，仅显示匹配的记录集

type (可选)

查询

字符串

根据类型过滤结果，仅显示匹配的记录集

ttl (可选)

查询

字符串

根据 ttl 过滤结果，仅显示匹配的记录集

data (可选)

查询

字符串

根据数据过滤结果，仅显示记录中包含匹配数据的记录集

status (可选)

查询

字符串

根据状态过滤结果，仅显示匹配的记录集

description (可选)

查询

字符串

根据描述过滤结果，仅显示匹配的记录集

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

metadata

body

对象

返回与此筛选器匹配的资源的 total_count

响应示例

{
    "recordsets": [
        {
            "description": "This is an example record set.",
            "links": {
                "self": "https://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets/f7b10e9b-0cae-4a91-b162-562bc6096648"
            },
            "updated_at": null,
            "records": [
                "10.1.0.2"
            ],
            "ttl": 3600,
            "id": "f7b10e9b-0cae-4a91-b162-562bc6096648",
            "name": "example.org.",
            "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
            "zone_id": "2150b1bf-dee2-4221-9d85-11f7886fb15f",
            "zone_name": "example.com.",
            "created_at": "2014-10-24T19:59:44.000000",
            "version": 1,
            "type": "A",
            "status": "PENDING",
            "action": "CREATE"
        }
    ],
    "links": {
        "self": "http://127.0.0.1:9001/v2/recordsets?limit=1",
        "next": "http://127.0.0.1:9001/v2/recordsets?limit=1&marker=45fd892d-7a67-4f65-9df0-87273f228d6c"
    },
    "metadata": {
        "total_count": 2
    }
}
GET
/v2/zones/{zone_id}/recordsets/{recordset_id}

显示记录集

显示单个记录集

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

recordset_id

路径

uuid

记录集的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "description": "This is an example record set.",
    "links": {
        "self": "https://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets/f7b10e9b-0cae-4a91-b162-562bc6096648"
    },
    "updated_at": null,
    "records": [
        "10.1.0.2"
    ],
    "ttl": 3600,
    "id": "f7b10e9b-0cae-4a91-b162-562bc6096648",
    "name": "example.org.",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "zone_id": "2150b1bf-dee2-4221-9d85-11f7886fb15f",
    "zone_name": "example.com.",
    "created_at": "2014-10-24T19:59:44.000000",
    "version": 1,
    "type": "A",
    "status": "ACTIVE",
    "action": "NONE"
}
PUT
/v2/zones/{zone_id}/recordsets/{recordset_id}

更新记录集

更新记录集

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

x-designate-edit-managed-records (可选)

标头

bool

如果启用，将允许用户编辑标记为已管理的记录

zone_id

路径

uuid

区域的 ID

recordset_id

路径

uuid

记录集的 ID

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

description (可选)

body

字符串

此记录集的描述

records

body

字符串

此记录集的数据列表。每个条目在 Designate 中将是一个单独的记录。这些条目应符合记录类型的 DNS 规范 - 例如，A 记录必须是 IPv4 地址，CNAME 记录必须是主机名。

请求示例

{
  "description" : "Updated description",
  "ttl" : null,
  "records" : [
      "10.1.0.2",
      "10.1.0.3"
  ]
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "description": "Updated description",
    "links": {
        "self": "https://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets/f7b10e9b-0cae-4a91-b162-562bc6096648"
    },
    "updated_at": null,
    "records": [
        "10.1.0.2",
        "10.1.0.3"
    ],
    "ttl": null,
    "id": "f7b10e9b-0cae-4a91-b162-562bc6096648",
    "name": "example.org.",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "zone_id": "2150b1bf-dee2-4221-9d85-11f7886fb15f",
    "zone_name": "example.com.",
    "created_at": "2014-10-24T19:59:44.000000",
    "version": 2,
    "type": "A",
    "status": "PENDING",
    "action": "UPDATE"
}
DELETE
/v2/zones/{zone_id}/recordsets/{recordset_id}

删除记录集

删除记录集

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

x-designate-edit-managed-records (可选)

标头

bool

如果启用，将允许用户编辑标记为已管理的记录

zone_id

路径

uuid

区域的 ID

recordset_id

路径

uuid

记录集的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "description": "Updated description",
    "links": {
        "self": "https://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets/f7b10e9b-0cae-4a91-b162-562bc6096648"
    },
    "updated_at": null,
    "records": [
        "10.1.0.2",
        "10.1.0.3"
    ],
    "ttl": null,
    "id": "f7b10e9b-0cae-4a91-b162-562bc6096648",
    "name": "example.org.",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "zone_id": "2150b1bf-dee2-4221-9d85-11f7886fb15f",
    "zone_name": "example.com.",
    "created_at": "2014-10-24T19:59:44.000000",
    "version": 2,
    "type": "A",
    "status": "PENDING",
    "action": "UPDATE"
}
POST
/v2/zones/{zone_id}/recordsets

创建 MX 记录集

在区域中创建一个 MX 记录集

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

x-designate-edit-managed-records (可选)

标头

bool

如果启用，将允许用户编辑标记为已管理的记录

zone_id

路径

uuid

区域的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

records

body

字符串

此记录集的数据列表。每个条目在 Designate 中将是一个单独的记录。这些条目应符合记录类型的 DNS 规范 - 例如，A 记录必须是 IPv4 地址，CNAME 记录必须是主机名。

请求示例

{
    "name" : "mail.example.org.",
    "description" : "An MX recordset.",
    "type" : "MX",
    "ttl" : 3600,
    "records" : [
        "10 mail1.example.org.",
        "20 mail2.example.org.",
        "30 mail3.example.org.",
        "40 mail4.example.org."
    ]
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "status": "PENDING",
    "description": "An MX recordset.",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/f6b472ed-1be8-47e8-87a7-687169cacca8/recordsets/c3c1f506-adcf-4751-ae5b-1c5ff00d2e1a"
    },
    "created_at": "2016-06-21 06:34:36",
    "updated_at": null,
    "records": [
        "10 mail1.example.org.",
        "30 mail3.example.org.",
        "20 mail2.example.org.",
        "40 mail4.example.org."
    ],
    "zone_id": "f6b472ed-1be8-47e8-87a7-687169cacca8",
    "version": 1,
    "ttl": 3600,
    "action": "CREATE",
    "zone_name": "example.org.",
    "type": "MX",
    "id": "c3c1f506-adcf-4751-ae5b-1c5ff00d2e1a",
    "name": "mail.example.org."
}
POST
/v2/zones/{zone_id}/recordsets

创建 SSHFP 记录集

在区域中创建一个 SSHFP 记录集

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

records

body

字符串

此记录集的数据列表。每个条目在 Designate 中将是一个单独的记录。这些条目应符合记录类型的 DNS 规范 - 例如，A 记录必须是 IPv4 地址，CNAME 记录必须是主机名。

请求示例

{
  "name" : "foo.example.org.",
  "description" : "An SSHFP recordset.",
  "type" : "SSHFP",
  "ttl" : 3600,
  "records" : [
    "1 2 6467a09c59607b01fef22ef6918c44a2eaaa14a5e055cfe91bf614b5796d2df0"
  ]
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "status": "ACTIVE",
    "description": null,
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/f6b472ed-1be8-47e8-87a7-687169cacca8/recordsets/5fb9d67c-86ac-4ae9-80d5-4c23f7a16b29"
    },
    "created_at": "2016-06-21 12:15:35",
    "updated_at": null,
    "records": [
        "2 1 75e080122854693164599205f49d7475ed17d09b"
    ],
    "zone_id": "f6b472ed-1be8-47e8-87a7-687169cacca8",
    "version": 1,
    "ttl": 3600,
    "action": "NONE",
    "zone_name": "example.org.",
    "type": "SSHFP",
    "id": "5fb9d67c-86ac-4ae9-80d5-4c23f7a16b29",
    "name": "foo.example.org."
}
POST
/v2/zones/{zone_id}/recordsets

创建 SPF 记录集

在区域中创建一个 SPF 记录集

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

records

body

字符串

此记录集的数据列表。每个条目在 Designate 中将是一个单独的记录。这些条目应符合记录类型的 DNS 规范 - 例如，A 记录必须是 IPv4 地址，CNAME 记录必须是主机名。

请求示例

{
  "name" : "foospf.example.org.",
  "description" : "An SPF recordset.",
  "type" : "SPF",
  "ttl" : 3600,
  "records" : [
      "v=spf1 +all"
  ]
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "status": "PENDING",
    "description": "An SPF recordset.",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/f6b472ed-1be8-47e8-87a7-687169cacca8/recordsets/c05a6740-2602-4439-bb70-187dd6547c13"
    },
    "created_at": "2016-06-21 12:31:44",
    "updated_at": null,
    "records": [
        "v=spf1 +all"
    ],
    "zone_id": "f6b472ed-1be8-47e8-87a7-687169cacca8",
    "version": 1,
    "ttl": 3600,
    "action": "CREATE",
    "zone_name": "example.org.",
    "type": "SPF",
    "id": "c05a6740-2602-4439-bb70-187dd6547c13",
    "name": "foospf.example.org."
}
POST
/v2/zones/{zone_id}/recordsets

创建 SRV 记录集

在区域中创建一个 SRV 记录集

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

zone_id

路径

uuid

区域的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

records

body

字符串

此记录集的数据列表。每个条目在 Designate 中将是一个单独的记录。这些条目应符合记录类型的 DNS 规范 - 例如，A 记录必须是 IPv4 地址，CNAME 记录必须是主机名。

请求示例

{
   "name" : "_http._tcp.example.org.",
   "description" : "An SRV recordset.",
   "type" : "SRV",
   "ttl" : 3600,
   "records" : [
        "10 0 5060 www.example.org."
   ]
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

project_id

body

uuid

拥有该资源的项目的 ID

name

body

hostname

记录集的 DNS 名称

ttl (可选)

body

整数

记录集的 TTL（生存时间）。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

zone_id

body

uuid

包含此记录集的区域的 ID

zone_name

body

字符串

包含此记录集的区域的名称

description (可选)

body

字符串

此记录集的描述

type

body

字符串

记录集的 RRTYPE。

版本

body

整数

资源的版本

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "status": "PENDING",
    "description": "An SRV recordset.",
    "links": {
        "self": "http://127.0.0.1:9001/v2/zones/f6b472ed-1be8-47e8-87a7-687169cacca8/recordsets/cc3299b3-c3cd-47e5-9876-8c1d4ad1b88e"
    },
    "created_at": "2016-06-21 12:44:38",
    "updated_at": null,
    "records": [
        "10 0 5060 www.example.org."
    ],
    "zone_id": "f6b472ed-1be8-47e8-87a7-687169cacca8",
    "version": 1,
    "ttl": 3600,
    "action": "CREATE",
    "zone_name": "example.org.",
    "type": "SRV",
    "id": "cc3299b3-c3cd-47e5-9876-8c1d4ad1b88e",
    "name": "_http._tcp.example.org."
}

池

获取 designate 安装中的池信息

GET
/v2/pools

列出所有池

获取池列表。

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

description

body

字符串

资源的描述。仅在 API / Horizon 中显示

id

body

uuid

此池的 ID

属性

body

对象

关于此池的信息的键值对。此信息可用于调度程序将区域放置在正确的池中

project_id

body

uuid

拥有该资源的项目的 ID

ns_records

body

字符串

此池的名称服务器。托管在此池中的任何区域都应委托给这些 DNS 服务器

name

body

字符串

此池的名称

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

metadata

body

对象

返回与此筛选器匹配的资源的 total_count

响应示例

{
  "metadata": {
    "total_count": 2
  },
  "links": {
    "self": "http://127.0.0.1:9001/v2/pools"
  },
  "pools": [
    {
      "description": null,
      "id": "794ccc2c-d751-44fe-b57f-8894c9f5c842",
      "project_id": null,
      "created_at": "2015-02-18T22:18:58.000000",
      "attributes": null,
      "ns_records": [
        {
          "hostname": "ns1.example.org.",
          "priority": 1
        }
      ],
      "links": {
        "self": "http://127.0.0.1:9001/v2/pools/794ccc2c-d751-44fe-b57f-8894c9f5c842"
      },
      "name": "default",
      "updated_at": "2015-02-19T15:59:44.000000"
    },
    {
      "description": null,
      "id": "d1716333-8c16-490f-85ee-29af36907605",
      "project_id": "noauth-project",
      "created_at": "2015-02-23T21:56:33.000000",
      "attributes": null,
      "ns_records": [
        {
          "hostname": "ns2.example.org.",
          "priority": 1
        }
      ],
      "links": {
        "self": "http://127.0.0.1:9001/v2/pools/d1716333-8c16-490f-85ee-29af36907605"
      },
      "name": "example_pool",
      "updated_at": null
    }
  ]
}
GET
/v2/pools/{pool_id}

显示一个池

获取特定的池

正常响应代码：200

错误响应代码：405,404,403,401,400,503

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

pool_id

路径

uuid

此池的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

description

body

字符串

资源的描述。仅在 API / Horizon 中显示

id

body

uuid

此池的 ID

属性

body

对象

关于此池的信息的键值对。此信息可用于调度程序将区域放置在正确的池中

project_id

body

uuid

拥有该资源的项目的 ID

ns_records

body

字符串

此池的名称服务器。托管在此池中的任何区域都应委托给这些 DNS 服务器

name

body

字符串

此池的名称

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

metadata

body

对象

返回与此筛选器匹配的资源的 total_count

响应示例

{
  "description": null,
  "id": "d1716333-8c16-490f-85ee-29af36907605",
  "project_id": "noauth-project",
  "created_at": "2015-02-23T21:56:33.000000",
  "attributes": null,
  "ns_records": [
    {
      "hostname": "ns2.example.org.",
      "priority": 1
    }
  ],
  "links": {
    "self": "http://127.0.0.1:9001/v2/pools/d1716333-8c16-490f-85ee-29af36907605"
  },
  "name": "example_pool",
  "updated_at": null
}

限制

显示当前项目的限制

GET
/v2/limits

获取项目限制

列出项目限制

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

max_page_limit

body

整数

每页允许的最大项目数量

max_recordset_name_length

body

整数

记录集名称的最大长度

max_recordset_records

body

整数

记录集中包含的最大记录数

max_zone_name_length

body

整数

区域名称的最大长度

max_zone_records

body

整数

区域中的最大记录数

max_zone_recordsets

body

整数

每个区域的最大记录集数

max_zones

body

整数

此项目的最大区域数

min_ttl

body

整数

此系统允许的最低 TTL

响应示例

{
  "max_page_limit": 1000,
  "max_recordset_name_length": 255,
  "max_recordset_records": 20,
  "max_zone_name_length": 255,
  "max_zone_records": 500,
  "max_zone_recordsets": 500,
  "max_zones": 10,
  "min_ttl": null
}

Tld

Tld 操作。

POST
/v2/tlds

创建 Tld

创建一个 tld

成功

代码

原因
201 - 已创建

请求已完成，并创建了新资源。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

name

body

字符串

此 tld 的名称

description (可选)

body

字符串

此 tld 的描述

请求示例

{
    "name" : "com",
    "description" : "tld description"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

name

body

字符串

此 tld 的名称

description (可选)

body

字符串

此 tld 的描述

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
   "name": "com",
   "links": {
     "self": "http://127.0.0.1:9001/v2/tlds/cfee7486-7ce4-4851-9c38-7b0fe3d42ee9"
   },
   "created_at": "2016-05-18 05:07:58",
   "updated_at": null,
   "id": "cfee7486-7ce4-4851-9c38-7b0fe3d42ee9",
   "description": "tld description"
}
GET
/v2/tlds/{tld_id}

显示 Tld

显示一个 tld

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

tld_id

路径

uuid

此 tld 的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

name

body

字符串

此 tld 的名称

description (可选)

body

字符串

此 tld 的描述

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
   "name": "com",
   "links": {
     "self": "http://127.0.0.1:9001/v2/tlds/cfee7486-7ce4-4851-9c38-7b0fe3d42ee9"
   },
   "created_at": "2016-05-18 05:07:58",
   "updated_at": null,
   "id": "cfee7486-7ce4-4851-9c38-7b0fe3d42ee9",
   "description": "tld description"
}
GET
/v2/tlds

列出 Tlds

列出与项目关联的 tld

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

limit (可选)

查询

整数

请求项目页面大小。返回最多限制值数量的项目。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

marker (可选)

查询

字符串

最后一个已查看项目的 ID。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

sort_dir (可选)

查询

字符串

按请求的排序方向对响应进行排序。有效值为 asc（升序）或 desc（降序）。默认值为 asc。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

sort_key (可选)

查询

字符串

按此属性值对响应进行排序。默认值为 id。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

name (可选)

查询

字符串

将结果过滤为仅显示名称与过滤器匹配的 tld

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

name

body

字符串

此 tld 的名称

description (可选)

body

字符串

此 tld 的描述

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
 "tlds": [
   {
     "name": "edu",
     "links": {
       "self": "http://127.0.0.1:9001/v2/tlds/a7bba387-712b-4b42-9368-4508642c6113"
     },
     "created_at": "2016-05-10 05:21:40",
     "updated_at": null,
     "id": "a7bba387-712b-4b42-9368-4508642c6113",
     "description": "demo TLD"
   },
   {
     "name": "com",
     "links": {
       "self": "http://127.0.0.1:9001/v2/tlds/cfee7486-7ce4-4851-9c38-7b0fe3d42ee9"
     },
     "created_at": "2016-05-18 05:07:58",
     "updated_at": null,
     "id": "cfee7486-7ce4-4851-9c38-7b0fe3d42ee9",
     "description": "tld description"
   }
 ],
 "links": {"self": "http://127.0.0.1:9001/v2/tlds"
 }
}
PATCH
/v2/tlds/{tld_id}

更新 Tld

更新一个 tld

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

tld_id

路径

uuid

此 tld 的 ID

name

body

字符串

此 tld 的名称

description (可选)

body

字符串

此 tld 的描述

请求示例

{
    "name" : "org",
    "description" : "Updated the name from com to org"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

name

body

字符串

此 tld 的名称

description (可选)

body

字符串

此 tld 的描述

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
  "name": "org",
  "links": {
    "self": "http://127.0.0.1:9001/v2/tlds/cfee7486-7ce4-4851-9c38-7b0fe3d42ee9"
  },
  "created_at": "2016-05-18 05:07:58",
  "updated_at": "2016-05-18 05:45:24",
  "id": "cfee7486-7ce4-4851-9c38-7b0fe3d42ee9",
  "description": "Updated the name from com to org"
}
DELETE
/v2/tlds/{tld_id}

删除 Tld

删除一个 tld

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

tld_id

路径

uuid

此 tld 的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

Tsigkey

事务签名 (TSIG) 是一种用于保护 DNS 消息并提供安全服务器到服务器通信（通常在主服务器和从服务器之间，但也可以扩展到动态更新）的机制。

POST
/v2/tsigkeys

创建 Tsigkeys

创建一个新的 Tsigkey

成功

代码

原因
201 - 已创建

请求已完成，并创建了新资源。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

name

body

字符串

此 tsigkey 的名称

algorithm

body

字符串

此 tsigkey 的加密算法

secret

body

字符串

要使用的实际密钥

scope

body

字符串

此 tsigkey 的范围，可以是 ZONE 或 POOL 范围

resource_id

body

字符串

此 tsigkey 的资源 ID，可以是 zone 或 pool ID

请求示例

{
    "name": "Example key",
    "algorithm": "hmac-sha256",
    "secret": "SomeSecretKey",
    "scope": "POOL",
    "resource_id": "d96851d0-765c-4ee9-bbdf-153345270bd3"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

resource_id

body

字符串

此 tsigkey 的资源 ID，可以是 zone 或 pool ID

name

body

字符串

此 tsigkey 的名称

scope

body

字符串

此 tsigkey 的范围，可以是 ZONE 或 POOL 范围

secret

body

字符串

要使用的实际密钥

algorithm

body

字符串

此 tsigkey 的加密算法

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "links": {
      "self": "http://127.0.0.1:9001/v2/tsigkeys/c429b860-9f68-4e5f-a2ff-65760a64ceaa"
    },
    "name": "Example key",
    "algorithm": "hmac-sha256",
    "resource_id": "d96851d0-765c-4ee9-bbdf-153345270bd3",
    "created_at": "2016-05-19 05:52:45",
    "updated_at": null,
    "secret": "SomeSecretKey",
    "scope": "POOL",
    "id": "c429b860-9f68-4e5f-a2ff-65760a64ceaa"
}
GET
/v2/tsigkeys

列出 Tsigkeys

列出所有 tsigkeys

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求参数

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

limit (可选)

查询

整数

请求项目页面大小。返回最多限制值数量的项目。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

marker (可选)

查询

字符串

最后一个已查看项目的 ID。使用 limit 参数进行初始限制请求，并在后续限制请求中使用响应中最后一个已查看项目的 ID 作为 marker 参数值。

sort_dir (可选)

查询

字符串

按请求的排序方向对响应进行排序。有效值为 asc（升序）或 desc（降序）。默认值为 asc。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

sort_key (可选)

查询

字符串

按此属性值对响应进行排序。默认值为 id。可以指定多个排序键和排序方向查询参数。如果在配对中省略了排序方向，则 API 将使用服务器提供的属性的自然排序方向作为 sort_key。

name (可选)

查询

字符串

将结果过滤为仅显示名称与过滤器匹配的 tsigkeys

algorithm (可选)

查询

字符串

将结果过滤为仅显示算法与过滤器匹配的 tsigkeys

scope (可选)

查询

字符串

将结果过滤为仅显示范围与过滤器匹配的 tsigkeys

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

resource_id

body

字符串

此 tsigkey 的资源 ID，可以是 zone 或 pool ID

name

body

字符串

此 tsigkey 的名称

scope

body

字符串

此 tsigkey 的范围，可以是 ZONE 或 POOL 范围

secret

body

字符串

要使用的实际密钥

algorithm

body

字符串

此 tsigkey 的加密算法

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "tsigkeys": [
        {
            "links": {
              "self": "http://127.0.0.1:9001/v2/tsigkeys/f94d03ca-bd55-4321-8e93-8d363737ab5c"
            },
            "name": "Example key",
            "algorithm": "hmac-sha256",
            "resource_id": "5866274f-ee8d-42ee-94f9-29000f040949",
            "created_at": "2016-04-19 18:52:54",
            "updated_at": null,
            "secret": "some secret key",
            "scope": "POOL",
            "id": "f94d03ca-bd55-4321-8e93-8d363737ab5c"
        },
        {
            "links": {
              "self": "http://127.0.0.1:9001/v2/tsigkeys/6bba6f00-dc33-4665-bb37-15f6188bb305"
            },
            "name": "Example key2",
            "algorithm": "hmac-sha256",
            "resource_id": "8a5ba22a-347e-4e92-9747-d2c3e67fbb45",
            "created_at": "2016-05-19 02:17:54",
            "updated_at": null,
            "secret": "SomeSecretKey",
            "scope": "POOL",
            "id": "6bba6f00-dc33-4665-bb37-15f6188bb305"
        },
        {
            "links": {
              "self": "http://127.0.0.1:9001/v2/tsigkeys/c429b860-9f68-4e5f-a2ff-65760a64ceaa"
            },
            "name": "Example key3",
            "algorithm": "hmac-sha256",
            "resource_id": "d96851d0-765c-4ee9-bbdf-153345270bd3",
            "created_at": "2016-05-19 05:52:45",
            "updated_at": null,
            "secret": "SomeSecretKey", "scope": "POOL",
            "id": "c429b860-9f68-4e5f-a2ff-65760a64ceaa"
        }
    ],
    "links": {
        "self": "http://127.0.0.1:9001/v2/tsigkeys"
    }
}
GET
/v2/tsigkeys/{tsigkey_id}

显示一个 Tsigkey

显示一个 tsigkey

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

tsigkey_id

路径

uuid

此 tsigkey 的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

resource_id

body

字符串

此 tsigkey 的资源 ID，可以是 zone 或 pool ID

name

body

字符串

此 tsigkey 的名称

scope

body

字符串

此 tsigkey 的范围，可以是 ZONE 或 POOL 范围

secret

body

字符串

要使用的实际密钥

algorithm

body

字符串

此 tsigkey 的加密算法

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "links": {
      "self": "http://127.0.0.1:9001/v2/tsigkeys/c429b860-9f68-4e5f-a2ff-65760a64ceaa"
    },
    "name": "Example key",
    "algorithm": "hmac-sha256",
    "resource_id": "d96851d0-765c-4ee9-bbdf-153345270bd3",
    "created_at": "2016-05-19 05:52:45",
    "updated_at": null,
    "secret": "SomeSecretKey",
    "scope": "POOL",
    "id": "c429b860-9f68-4e5f-a2ff-65760a64ceaa"
}
PATCH
/v2/tsigkeys/{tsigkey_id}

更新 Tsigkey

更新现有 tsigkey 的属性

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求参数

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

name

body

字符串

此 tsigkey 的名称

algorithm

body

字符串

此 tsigkey 的加密算法

secret

body

字符串

要使用的实际密钥

scope

body

字符串

此 tsigkey 的范围，可以是 ZONE 或 POOL 范围

resource_id

body

字符串

此 tsigkey 的资源 ID，可以是 zone 或 pool ID

tsigkey_id

路径

uuid

此 tsigkey 的 ID

请求示例

{
  "name": "example_tsigkey",
  "scope": "ZONE"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

resource_id

body

字符串

此 tsigkey 的资源 ID，可以是 zone 或 pool ID

name

body

字符串

此 tsigkey 的名称

scope

body

字符串

此 tsigkey 的范围，可以是 ZONE 或 POOL 范围

secret

body

字符串

要使用的实际密钥

algorithm

body

字符串

此 tsigkey 的加密算法

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "links": {
      "self": "http://127.0.0.1:9001/v2/tsigkeys/c429b860-9f68-4e5f-a2ff-65760a64ceaa"
      },
      "name": "example_tsigkey",
      "algorithm": "hmac-sha256",
      "resource_id": "d96851d0-765c-4ee9-bbdf-153345270bd3",
      "created_at": "2016-05-19 05:52:45",
      "updated_at": "2016-05-19 06:29:14",
      "secret": "SomeSecretKey",
      "scope": "ZONE",
      "id": "c429b860-9f68-4e5f-a2ff-65760a64ceaa"
}
DELETE
/v2/tsigkeys/{tsigkey_id}

删除一个 Tsigkey

删除一个 tsigkey

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

tsigkey_id

路径

uuid

此 tsigkey 的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

Blacklists

黑名单条目用于管理黑名单区域。如果一个区域被列入黑名单，则无法使用它来创建区域。默认情况下，只有管理员可以管理这些条目。黑名单区域作为数据库/存储中的黑名单表中的正则表达式 (regex) 模式存储。

POST
/v2/blacklists

创建黑名单

创建一个黑名单

响应代码

成功

代码

原因
201 - 已创建

请求已完成，并创建了新资源。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
500 - 内部服务器错误

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

服务现在无法处理请求。

请求参数

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

pattern

body

字符串

此黑名单的模式

description (可选)

body

字符串

此黑名单的描述

请求示例

{
  "pattern" : "^([A-Za-z0-9_\\-]+\\.)*example\\.com\\.$",
  "description" : "This is a blacklisted domain."
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pattern

body

字符串

此黑名单的模式

description (可选)

body

字符串

此黑名单的描述

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "description": "This is a blacklisted domain.",
    "links": {
      "self": "http://127.0.0.1:9001/v2/blacklists/af91edb5-ede8-453f-af13-feabdd088f9c"
    },
    "pattern": "^([A-Za-z0-9_\\-]+\\.)*example\\.com\\.$",
    "created_at": "2016-05-20 06:15:42",
    "updated_at": null,
    "id": "af91edb5-ede8-453f-af13-feabdd088f9c"
}
GET
/v2/blacklists

列出黑名单

列出所有黑名单

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求参数

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

pattern (可选)

查询

字符串

将结果过滤为仅显示模式与过滤器匹配的黑名单

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pattern

body

字符串

此黑名单的模式

description (可选)

body

字符串

此黑名单的描述

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "blacklists": [
        {
            "description": "This is a blacklisted domain.",
            "links": {
              "self": "http://127.0.0.1:9001/v2/blacklists/af91edb5-ede8-453f-af13-feabdd088f9c"
            },
            "pattern": "^([A-Za-z0-9_\\-]+\\.)*example\\.com\\.$",
            "created_at": "2016-05-20 06:15:42",
            "updated_at": null,
            "id": "af91edb5-ede8-453f-af13-feabdd088f9c"
        },
        {
            "description": "Example blacklisted domain.",
            "links": {
              "self": "http://127.0.0.1:9001/v2/blacklists/f26e22f8-619f-4738-9077-0586e7cb76bd"
            },
            "pattern": "^examples\\.com\\.$",
            "created_at": "2016-05-20 06:22:12",
            "updated_at": null,
            "id": "f26e22f8-619f-4738-9077-0586e7cb76bd"
        }
     ],
     "links": {
       "self": "http://127.0.0.1:9001/v2/blacklists"
     }
}
GET
/v2/blacklists/{blacklist_id}

显示黑名单

显示一个黑名单

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

blacklist_id

路径

uuid

此黑名单的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pattern

body

字符串

此黑名单的模式

description (可选)

body

字符串

此黑名单的描述

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "description": "This is a blacklisted domain.",
    "links": {
      "self": "http://127.0.0.1:9001/v2/blacklists/af91edb5-ede8-453f-af13-feabdd088f9c"
    },
    "pattern": "^([A-Za-z0-9_\\-]+\\.)*example\\.com\\.$",
    "created_at": "2016-05-20 06:15:42",
    "updated_at": null,
    "id": "af91edb5-ede8-453f-af13-feabdd088f9c"
}
PATCH
/v2/blacklists/{blacklist_id}

更新黑名单

更新一个黑名单

正常响应代码：200

错误响应代码：405,404,403,401,400,503

请求参数

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

pattern

body

字符串

此黑名单的模式

description (可选)

body

字符串

此黑名单的描述

blacklist_id

路径

uuid

此黑名单的 ID

请求示例

{
    "pattern" : "^examples\\.com\\.$",
    "description" : "Updated the description"
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

uuid

资源的 ID

pattern

body

字符串

此黑名单的模式

description (可选)

body

字符串

此黑名单的描述

created_at

body

时间戳

创建资源的时间/日期。

updated_at

body

时间戳

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

links

body

对象

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

响应示例

{
    "description": "Updated the description",
    "links": {
      "self": "http://127.0.0.1:9001/v2/blacklists/f26e22f8-619f-4738-9077-0586e7cb76bd"
    },
    "pattern": "^examples\\.com\\.$",
    "created_at": "2016-05-20 06:22:12",
    "updated_at": "2016-05-20 06:41:34",
    "id": "f26e22f8-619f-4738-9077-0586e7cb76bd"
}
DELETE
/v2/blacklists/{blacklist_id}

删除一个黑名单

删除一个黑名单

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

blacklist_id

路径

uuid

此黑名单的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

配额

配额操作。

GET
/v2/quotas/{project_id}

查看配额

查看项目的配额

这将返回系统上配额的键：值集。

注意

如果用户正在查看另一个项目的配额，则需要将 x-auth-all-projects 设置为 True

他们需要具有具有 All-Projects 权限的角色才能执行此操作。

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

project_id

路径

uuid

项目的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

响应示例

{
    "api_export_size": 1000,
    "recordset_records": 20,
    "zone_records": 500,
    "zone_recordsets": 500,
    "zones": 100
}
GET
/v2/quotas/

查看当前项目的配额

查看当前项目的配额

这将返回系统上配额的键：值集。

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

project_id

路径

uuid

项目的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

响应示例

{
    "api_export_size": 1000,
    "recordset_records": 20,
    "zone_records": 500,
    "zone_recordsets": 500,
    "zones": 100
}
PATCH
/v2/quotas/{project_id}

设置配额

设置项目的配额

请求应为要设置的配额的键：值集

这将返回系统上配额的键：值集。

注意

如果用户正在更新另一个项目的配额，则需要将 x-auth-all-projects 设置为 True

他们需要具有“All-Projects”和“set-quotas”权限的角色才能执行此操作。

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求示例

{
    "zones": 500
}

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

project_id

路径

uuid

项目的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

响应示例

{
    "api_export_size": 1000,
    "recordset_records": 20,
    "zone_records": 500,
    "zone_recordsets": 500,
    "zones": 500
}
DELETE
/v2/quotas/{project_id}

重置配额

将项目的所有配额重置为默认值

注意

如果用户正在重置另一个项目的配额，则需要将 x-auth-all-projects 设置为 True

他们需要具有 All-Projects 和“set-quotas”权限的角色才能执行此操作。

成功

代码

原因
204 - No Content

请求已满足，但服务未返回任何内容。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

project_id

路径

uuid

项目的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

服务状态

服务状态条目用于跟踪 Designate 系统中服务的运行状况。每个服务将通过 RPC 或使用 HTTP 报告其运行状况。

GET
/v2/service_statuses

列出状态

列出所有服务和状态。

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求参数

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

capabilities

body

dict

服务的能力。

created_at

body

时间戳

创建资源的时间/日期。

heartbeated_at

body

时间戳

接收到上次心跳的时间戳。

hostname

body

字符串

具有服务实例的主机的主机名。

id

body

uuid

资源的 ID

links

body

对象

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

service_name

body

字符串

Designate 服务实例的名称。

service_statuses

body

数组

一个 service_statuses 对象列表。

stats

body

dict

服务的统计信息。

status

body

enum

资源的当前状态。

updated_at

body

时间戳

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

响应示例

{
    "service_statuses": [
        {
            "links": {
              "self": "http://127.0.0.1:9001/v2/service_statuses/af91edb5-ede8-453f-af13-feabdd088f9c"
            },
            "hostname": "dns-2.example.com.",
            "status": "UP",
            "service_name": "api",
            "stats": null,
            "capabilities": null,
            "created_at": "2016-05-20 06:15:42",
            "heartbeated_at": "2016-07-20 12:14:41",
            "id": "af91edb5-ede8-453f-af13-feabdd088f9c"
        }
     ],
     "links": {
       "self": "http://127.0.0.1:9001/v2/service_statuses"
     }
}
GET
/v2/service_statuses/{service_id}

显示服务状态

显示服务的状态。

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求参数

名称

入参

类型

描述

service_id

路径

uuid

服务的 ID。

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

capabilities

body

dict

服务的能力。

created_at

body

时间戳

创建资源的时间/日期。

heartbeated_at

body

时间戳

接收到上次心跳的时间戳。

hostname

body

字符串

具有服务实例的主机的主机名。

id

body

uuid

资源的 ID

links

body

对象

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

service_name

body

字符串

Designate 服务实例的名称。

stats

body

dict

服务的统计信息。

status

body

enum

资源的当前状态。

updated_at

body

时间戳

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

响应示例

{
  "id": "c0bcb136-5f5c-4427-9f89-99d457819917",
  "hostname": "dns-2.example.com",
  "service_name": "central",
  "status": "UP",
  "stats": {},
  "capabilities": {},
  "heartbeated_at": "2021-03-24T23:51:12.000000",
  "created_at": "2021-03-22T20:59:24.000000",
  "updated_at": "2021-03-24T23:51:12.000000",
  "links": {
    "self": "http://10.21.21.88/v2/service_statuses/c0bcb136-5f5c-4427-9f89-99d457819917"
  }
}

FloatingIPs

为了使用 FloatingIPs 功能，您需要在 Neutron 中将 FloatingIP 关联到您的项目。

PATCH
/v2/reverse/floatingips/{region}:{floatingip_id}

设置浮动 IP 的 PTR 记录

为给定的浮动 IP 设置 PTR 记录。如果不存在，域名将自动配置。

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
409 - Conflict

此资源有一个正在进行的操作，与此请求冲突。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

ptrdname

body

字符串

此 PTR 记录的域名

description

body

字符串

此 PTR 记录的描述

ttl

body

uuid

此 PTR 记录的生存时间

region

路径

字符串

Openstack 区域

floatingip_id

路径

uuid

与项目关联的浮动 IP 的 ID

请求示例

{
  "ptrdname" : "smtp.example.com.",
  "description" : "This is a floating ip for 10.0.0.8",
  "ttl": 600
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

字符串

格式为 <region>:<floatingip_id> 的 PTR 记录 ID

ptrdname

body

字符串

此 PTR 记录的域名

description

body

字符串

此 PTR 记录的描述

ttl

body

uuid

此 PTR 记录的生存时间

address

body

字符串

此 PTR 记录的浮动 IP 地址。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

links

body

对象

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

响应示例

{
    "status": "PENDING",
    "ptrdname": "smtp.example.com.",
    "description": "This is a floating ip for 127.0.0.1",
    "links": {
        "self": "http://127.0.0.1:9001/v2/reverse/floatingips/RegionOne:c5742ac0-d0f3-4304-a039-9423f727eb96"
    },
    "ttl": 600,
    "address": "172.24.4.10",
    "action": "CREATE",
    "id": "RegionOne:c5742ac0-d0f3-4304-a039-9423f727eb96"
}
GET
/v2/reverse/floatingips/{region}:{floatingip_id}

显示浮动 IP 的 PTR 记录

显示特定的浮动 IP PTR

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

region

路径

字符串

Openstack 区域

floatingip_id

路径

uuid

与项目关联的浮动 IP 的 ID

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

字符串

格式为 <region>:<floatingip_id> 的 PTR 记录 ID

ptrdname

body

字符串

此 PTR 记录的域名

description

body

字符串

此 PTR 记录的描述

ttl

body

uuid

此 PTR 记录的生存时间

address

body

字符串

此 PTR 记录的浮动 IP 地址。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

links

body

对象

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

响应示例

{
    "status": "PENDING",
    "ptrdname": "smtp.example.com.",
    "description": "This is a floating ip for 127.0.0.1",
    "links": {
        "self": "http://127.0.0.1:9001/v2/reverse/floatingips/RegionOne:c5742ac0-d0f3-4304-a039-9423f727eb96"
    },
    "ttl": 600,
    "address": "172.24.4.10",
    "action": "CREATE",
    "id": "RegionOne:c5742ac0-d0f3-4304-a039-9423f727eb96"
}
GET
/v2/reverse/floatingips

列出浮动 IP 的 PTR 记录

列出浮动 IP PTR 记录

成功

代码

原因
200 - 正常

请求成功。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID

id

body

字符串

格式为 <region>:<floatingip_id> 的 PTR 记录 ID

ptrdname

body

字符串

此 PTR 记录的域名

description

body

字符串

此 PTR 记录的描述

ttl

body

uuid

此 PTR 记录的生存时间

address

body

字符串

此 PTR 记录的浮动 IP 地址。

status

body

enum

资源的当前状态。

动作

body

enum

资源上当前正在进行的操作

links

body

对象

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

响应示例

{
    "links": {
        "self": "http://127.0.0.1:9001/v2/reverse/floatingips"
    },
    "floatingips": [
      {
          "status": "ACTIVE",
          "ptrdname": "smtp.example.com.",
          "description": null,
          "links": {
              "self": "http://127.0.0.1:9001/v2/reverse/floatingips/RegionOne:c5742ac0-d0f3-4304-a039-9423f727eb96"
          },
          "ttl": 600,
          "address": "172.24.4.10",
          "action": "NONE",
          "id": "RegionOne:c5742ac0-d0f3-4304-a039-9423f727eb96"
      },
      {
          "status": "ACTIVE",
          "ptrdname": "tftp.example.com.",
          "description": null,
          "links": {
              "self": "http://127.0.0.1:9001/v2/reverse/floatingips/RegionOne:9860717d-3da6-43df-a0ec-fa8b0e71ea86"
          },
          "ttl": 600,
          "address": "172.24.4.6",
          "action": "NONE",
          "id": "RegionOne:9860717d-3da6-43df-a0ec-fa8b0e71ea86"
      }
    ]
}
PATCH
/v2/reverse/floatingips/{region}:{floatingip_id}

取消设置浮动 IP 的 PTR 记录

取消设置浮动 IP 的 PTR 记录

成功

代码

原因
202 - Accepted

请求已接受，但处理可能需要一些时间。

错误

代码

原因
400 - 请求错误

请求中的某些内容无效。
401 - 未授权

用户必须在发出请求之前进行身份验证。
403 - 禁止

策略不允许当前用户执行此操作。
404 - Not Found

找不到请求的资源。
405 - 方法不允许

该方法对于此端点和资源无效。
503 - 服务不可用

服务现在无法处理请求。

请求

名称

入参

类型

描述

x-auth-token (可选)

标头

字符串

用于从 keystone 识别用户的令牌

x-auth-all-projects (可选)

标头

bool

如果启用，将显示 Designate 中所有项目的结果

x-auth-sudo-project-id (可选)

标头

字符串

允许用户模拟另一个项目

region

路径

字符串

Openstack 区域

floatingip_id

路径

uuid

与项目关联的浮动 IP 的 ID

请求示例

{
    "ptrdname": null
}

响应参数

名称

入参

类型

描述

x-openstack-request-id

标头

字符串

请求的 ID