OpenShift 文档正在迁移，很快将只在 docs.redhat.com（所有 Red Hat 产品文档的中心）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

DNS [config.openshift.io/v1]

描述

DNS 包含有关 DNS 的集群范围信息。规范名称为 cluster 兼容性级别 1：在一个主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

  • spec

规格

属性 类型 描述

apiVersion

字符串

APIVersion 定义了对象的此表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。采用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

spec 包含用户可设置的配置值

status

对象

status 包含来自集群的观察值。它们不能被覆盖。

.spec

描述

spec 包含用户可设置的配置值

类型

对象

属性 类型 描述

baseDomain

字符串

baseDomain 是集群的基本域名。所有托管的 DNS 记录都将是此基本域名的子域名。例如，给定基本域名 openshift.example.com，可以为 cluster-api.openshift.example.com 创建 API 服务器 DNS 记录。设置后，此字段将无法更改。

platform

对象

platform 包含特定于 DNS 的底层基础架构提供商的配置。省略此项表示用户没有意见，平台将选择合理的默认值。这些默认值可能会随着时间的推移而发生变化。

privateZone

对象

privateZone 是集群内部唯一可访问的所有 DNS 记录所在的位置。如果此字段为空，则不应创建任何私有记录。设置后，此字段将无法更改。

publicZone

对象

publicZone 是互联网上公开可访问的所有 DNS 记录所在的位置。如果此字段为空，则不应创建任何公共记录。设置后，此字段将无法更改。

.spec.platform

描述

platform 包含特定于 DNS 的底层基础架构提供商的配置。省略此项表示用户没有意见，平台将选择合理的默认值。这些默认值可能会随着时间的推移而发生变化。

类型

对象

必需

  • type

属性 类型 描述

aws

对象

aws 包含特定于 Amazon Web Services 云提供商的 DNS 配置。

type

字符串

type 是集群的底层基础架构提供商。允许的值：""、"AWS"。各个组件可能不支持所有平台，并且必须尽力处理无法识别的平台的默认值。

.spec.platform.aws

描述

aws 包含特定于 Amazon Web Services 云提供商的 DNS 配置。

类型

对象

属性 类型 描述

privateZoneIAMRole

字符串

privateZoneIAMRole 包含在对集群 DNS 配置中指定的集群私有托管区域执行操作时应承担的 IAM 角色的 ARN。留空表示不应承担任何角色。

.spec.privateZone

描述

privateZone 是集群内部唯一可访问的所有 DNS 记录所在的位置。如果此字段为空，则不应创建任何私有记录。设置后，此字段将无法更改。

类型

对象

属性 类型 描述

id

字符串

id 是用于查找 DNS 托管区的标识符。在 AWS 上，可以使用ID作为 [1] 中的 id 来获取区域；在 Azure 上，可以使用ID作为预定名称来获取区域 [2]；在 GCP 上，可以使用ID作为预定名称来获取区域 [3]。[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get

标签

对象 (字符串)

可以使用标签来查询 DNS 托管区。在 AWS 上，可以使用 resourcegroupstaggingapi [1] 使用Tags作为标签过滤器来获取区域，[1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options

.spec.publicZone

描述

publicZone 是互联网上公开可访问的所有 DNS 记录所在的位置。如果此字段为空，则不应创建任何公共记录。设置后，此字段将无法更改。

类型

对象

属性 类型 描述

id

字符串

id 是用于查找 DNS 托管区的标识符。在 AWS 上，可以使用ID作为 [1] 中的 id 来获取区域；在 Azure 上，可以使用ID作为预定名称来获取区域 [2]；在 GCP 上，可以使用ID作为预定名称来获取区域 [3]。[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get

标签

对象 (字符串)

可以使用标签来查询 DNS 托管区。在 AWS 上，可以使用 resourcegroupstaggingapi [1] 使用Tags作为标签过滤器来获取区域，[1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options

.status

描述

status 包含来自集群的观察值。它们不能被覆盖。

类型

对象

API 端点

以下 API 端点可用

  • /apis/config.openshift.io/v1/dnses

    • DELETE: 删除 DNS 集合

    • GET: 列出 DNS 对象

    • POST: 创建 DNS

  • /apis/config.openshift.io/v1/dnses/{name}

    • DELETE: 删除 DNS

    • GET: 读取指定的 DNS

    • PATCH: 部分更新指定的 DNS

    • PUT: 替换指定的 DNS

  • /apis/config.openshift.io/v1/dnses/{name}/status

    • GET: 读取指定的 DNS 状态

    • PATCH: 部分更新指定的 DNS 状态

    • PUT: 替换指定的 DNS 状态

/apis/config.openshift.io/v1/dnses

HTTP 方法

DELETE

描述

删除 DNS 集合

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 DNS 对象

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

DNSList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 DNS

表 3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 4. 请求体参数
参数 类型 描述

请求体

DNS 模式
表 5. HTTP 响应
HTTP 代码 响应体

200 - OK

DNS 模式

201 - 已创建

DNS 模式

202 - 已接受

DNS 模式

401 - 未授权

空

/apis/config.openshift.io/v1/dnses/{name}

表 6. 全局路径参数
参数 类型 描述

name

字符串

DNS 的名称
HTTP 方法

DELETE

描述

删除 DNS

表 7. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 8. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 DNS

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

DNS 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 DNS

表 10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 11. HTTP 响应
HTTP 代码 响应体

200 - OK

DNS 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 DNS

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 13. 请求体参数
参数 类型 描述

请求体

DNS 模式
表 14. HTTP 响应
HTTP 代码 响应体

200 - OK

DNS 模式

201 - 已创建

DNS 模式

401 - 未授权

空

/apis/config.openshift.io/v1/dnses/{name}/status

表 15. 全局路径参数
参数 类型 描述

name

字符串

DNS 的名称
HTTP 方法

GET

描述

读取指定的 DNS 状态

表 16. HTTP 响应
HTTP 代码 响应体

200 - OK

DNS 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 DNS 状态

表 17. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 18. HTTP 响应
HTTP 代码 响应体

200 - OK

DNS 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 DNS 状态

表 19. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段以及遇到的每个重复字段，这都将通过标准警告响应标头发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 20. 请求体参数
参数 类型 描述

请求体

DNS 模式
表 21. HTTP 响应
HTTP 代码 响应体

200 - OK

DNS 模式

201 - 已创建

DNS 模式

401 - 未授权

空