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

CloudPrivateIPConfig [cloud.network.openshift.io/v1]

描述

CloudPrivateIPConfig 将私有 IP 地址分配给与云虚拟机关联的主 NIC。这是通过指定 IP 和应分配 IP 的 Kubernetes 节点来完成的。此 CRD 旨在由管理集群网络的网络插件使用。spec 部分表示网络插件请求的所需状态，status 部分表示此 CRD 的控制器已执行的当前状态。用户将无权修改它，如果集群管理员决定出于某种原因编辑它，则下次网络插件协调对象时，他们的更改将被覆盖。注意：CR 的名称必须指定请求的私有 IP 地址（可以是 IPv4 或 IPv6）。兼容性级别 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 是所需私有 IP 请求的定义。

status

对象

status 是所需私有 IP 请求的观察到的状态。只读。

.spec

描述

spec 是所需私有 IP 请求的定义。

类型

对象

属性 类型 描述

node

字符串

node 是节点名称，由 Kubernetes 字段 node.metadata.name 指定

.status

描述

status 是所需私有 IP 请求的观察到的状态。只读。

类型

对象

必需

  • conditions

属性 类型 描述

conditions

数组

condition 是私有 IP 及其状态的分配条件

conditions[]

对象

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 中的数组。例如，类型 FooStatus struct{ // 表示对 foo 当前状态的观察。 // 已知的 .status.conditions.type 为：“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

node

字符串

node 是节点名称，由 Kubernetes 字段 node.metadata.name 指定

.status.conditions

描述

condition 是私有 IP 及其状态的分配条件

类型

数组

.status.conditions[]

描述

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 中的数组。例如，类型 FooStatus struct{ // 表示对 foo 当前状态的观察。 // 已知的 .status.conditions.type 为：“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

类型

对象

必需

  • lastTransitionTime

  • message

  • reason

  • status

  • type

属性 类型 描述

lastTransitionTime

字符串

lastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。这应该是底层条件更改的时间。如果不知道这一点，则可以使用 API 字段更改的时间。

message

字符串

message 是一个易于理解的消息，指示有关转换的详细信息。这可能是一个空字符串。

observedGeneration

整数

observedGeneration 表示设置条件时所基于的 .metadata.generation。例如，如果当前 .metadata.generation 为 12，但 .status.conditions[x].observedGeneration 为 9，则该条件相对于实例的当前状态已过期。

reason

字符串

reason 包含一个程序标识符，指示条件上次转换的原因。特定条件类型的生产者可以为此字段定义预期的值和含义，以及这些值是否被视为保证的 API。该值应为驼峰式字符串。此字段不能为空。

status

字符串

条件的状态，取值为 True、False 或 Unknown 之一。

type

字符串

条件的类型，使用驼峰式命名法或 foo.example.com/CamelCase 格式。——许多 .condition.type 值在不同资源中保持一致，例如 Available，但由于任意条件可能很有用（参见 .node.status.conditions），因此解冲突的能力非常重要。它匹配的正则表达式为 (dns1123SubdomainFmt/)?(qualifiedNameFmt)

API 端点

提供以下 API 端点

  • /apis/cloud.network.openshift.io/v1/cloudprivateipconfigs

    • DELETE：删除 CloudPrivateIPConfig 集合

    • GET：列出 CloudPrivateIPConfig 对象

    • POST：创建一个 CloudPrivateIPConfig

  • /apis/cloud.network.openshift.io/v1/cloudprivateipconfigs/{name}

    • DELETE：删除一个 CloudPrivateIPConfig

    • GET：读取指定的 CloudPrivateIPConfig

    • PATCH：部分更新指定的 CloudPrivateIPConfig

    • PUT：替换指定的 CloudPrivateIPConfig

  • /apis/cloud.network.openshift.io/v1/cloudprivateipconfigs/{name}/status

    • GET：读取指定的 CloudPrivateIPConfig 的状态

    • PATCH：部分更新指定的 CloudPrivateIPConfig 的状态

    • PUT：替换指定的 CloudPrivateIPConfig 的状态

/apis/cloud.network.openshift.io/v1/cloudprivateipconfigs

HTTP 方法

DELETE

描述

删除 CloudPrivateIPConfig 集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 CloudPrivateIPConfig 对象

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

200 - OK

CloudPrivateIPConfigList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 CloudPrivateIPConfig

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

CloudPrivateIPConfig 模式

201 - 已创建

CloudPrivateIPConfig 模式

202 - 已接受

CloudPrivateIPConfig 模式

401 - 未授权

空

/apis/cloud.network.openshift.io/v1/cloudprivateipconfigs/{name}

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

name

字符串

CloudPrivateIPConfig 的名称
HTTP 方法

DELETE

描述

删除一个 CloudPrivateIPConfig

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 CloudPrivateIPConfig

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

200 - OK

CloudPrivateIPConfig 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 CloudPrivateIPConfig

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

CloudPrivateIPConfig 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 CloudPrivateIPConfig

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

CloudPrivateIPConfig 模式

201 - 已创建

CloudPrivateIPConfig 模式

401 - 未授权

空

/apis/cloud.network.openshift.io/v1/cloudprivateipconfigs/{name}/status

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

name

字符串

CloudPrivateIPConfig 的名称
HTTP 方法

GET

描述

读取指定的 CloudPrivateIPConfig 的状态

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

200 - OK

CloudPrivateIPConfig 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 CloudPrivateIPConfig 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

CloudPrivateIPConfig 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 CloudPrivateIPConfig 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

CloudPrivateIPConfig 模式

201 - 已创建

CloudPrivateIPConfig 模式

401 - 未授权

空