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

IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]

规格

属性 类型 描述

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

对象

IPAddressClaimSpec 是 IPAddressClaim 的期望状态。

status

对象

IPAddressClaimStatus 是 IPAddressClaim 的观察到的状态。

.spec

描述

IPAddressClaimSpec 是 IPAddressClaim 的期望状态。

类型

对象

必需

  • poolRef

属性 类型 描述

poolRef

对象

PoolRef 是一个引用，指向应该从中创建 IP 地址的池。

.spec.poolRef

描述

PoolRef 是一个引用，指向应该从中创建 IP 地址的池。

类型

对象

必需

  • kind

  • 名称

属性 类型 描述

apiGroup

字符串

APIGroup 是被引用资源的组。如果未指定 APIGroup，则指定的 Kind 必须位于核心 API 组中。对于任何其他第三方类型，都需要 APIGroup。

kind

字符串

Kind 是被引用资源的类型

名称

字符串

Name 是被引用资源的名称

.status

描述

IPAddressClaimStatus 是 IPAddressClaim 的观察到的状态。

类型

对象

属性 类型 描述

addressRef

对象

AddressRef 是对为此声明创建的地址的引用。

conditions

数组

Conditions 总结了 IPAddressClaim 的当前状态

conditions[]

对象

Condition 定义了对集群 API 资源操作状态的观察。

.status.addressRef

描述

AddressRef 是对为此声明创建的地址的引用。

类型

对象

属性 类型 描述

名称

字符串

引用的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names 待办事项：添加其他有用的字段。apiVersion、kind、uid？

.status.conditions

描述

Conditions 总结了 IPAddressClaim 的当前状态

类型

数组

.status.conditions[]

描述

Condition 定义了对集群 API 资源操作状态的观察。

类型

对象

必需

  • lastTransitionTime

  • status

  • 类型

属性 类型 描述

lastTransitionTime

字符串

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

消息

字符串

一个易于理解的消息，指示有关转换的详细信息。此字段可能为空。

原因

字符串

条件最后一次转换的原因，采用驼峰式命名法。特定 API 可以选择此字段是否被视为保证的 API。此字段不能为空。

严重性

字符串

严重性提供了对原因代码的明确分类，以便用户或机器可以立即理解当前情况并采取相应的措施。只有当 Status=False 时，才必须设置 Severity 字段。

status

字符串

条件的状态，True、False、Unknown 之一。

类型

字符串

条件的类型，采用驼峰式命名法或 foo.example.com/CamelCase 格式。许多 .condition.type 值在资源之间是一致的，例如 Available，但是由于任意条件可能很有用（参见 .node.status.conditions），因此消除冲突的能力非常重要。

API 端点

提供以下 API 端点

  • /apis/ipam.cluster.x-k8s.io/v1beta1/ipaddressclaims

    • GET：列出 IPAddressClaim 类型的对象

  • /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims

    • DELETE：删除 IPAddressClaim 集合

    • GET：列出 IPAddressClaim 类型的对象

    • POST：创建 IPAddressClaim

  • /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}

    • DELETE：删除 IPAddressClaim

    • GET：读取指定的 IPAddressClaim

    • PATCH：部分更新指定的 IPAddressClaim

    • PUT：替换指定的 IPAddressClaim

  • /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}/status

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

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

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

/apis/ipam.cluster.x-k8s.io/v1beta1/ipaddressclaims

HTTP 方法

GET

描述

列出 IPAddressClaim 类型的对象

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

200 - OK

IPAddressClaimList 模式

401 - 未授权

空

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims

HTTP 方法

DELETE

描述

删除 IPAddressClaim 集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 IPAddressClaim 类型的对象

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

200 - OK

IPAddressClaimList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 IPAddressClaim

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

dryRun

字符串

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

fieldValidation

字符串

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

主体

IPAddressClaim 模式
表 6. HTTP 响应
HTTP 代码 响应体

200 - OK

IPAddressClaim 模式

201 - 已创建

IPAddressClaim 模式

202 - 已接受

IPAddressClaim 模式

401 - 未授权

空

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}

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

名称

字符串

IPAddressClaim 的名称
HTTP 方法

DELETE

描述

删除 IPAddressClaim

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 IPAddressClaim

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

200 - OK

IPAddressClaim 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 IPAddressClaim

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

IPAddressClaim 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 IPAddressClaim

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

dryRun

字符串

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

fieldValidation

字符串

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

主体

IPAddressClaim 模式
表 15. HTTP 响应
HTTP 代码 响应体

200 - OK

IPAddressClaim 模式

201 - 已创建

IPAddressClaim 模式

401 - 未授权

空

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}/status

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

名称

字符串

IPAddressClaim 的名称
HTTP 方法

GET

描述

读取指定的 IPAddressClaim 的状态

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

200 - OK

IPAddressClaim 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 IPAddressClaim 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

IPAddressClaim 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 IPAddressClaim 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

主体

IPAddressClaim 模式
表 22. HTTP 响应
HTTP 代码 响应体

200 - OK

IPAddressClaim 模式

201 - 已创建

IPAddressClaim 模式

401 - 未授权

空