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

IPAddress [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

对象

IPAddressSpec 是 IPAddress 的期望状态。

.spec

描述

IPAddressSpec 是 IPAddress 的期望状态。

类型

对象

必需

  • address

  • claimRef

  • poolRef

  • prefix

属性 类型 描述

address

字符串

Address 是 IP 地址。

claimRef

对象

ClaimRef 是对为此 IPAddress 创建的声明的引用。

gateway

字符串

Gateway 是地址所属网络的网络网关。

poolRef

对象

PoolRef 是对此 IPAddress 创建的池的引用。

prefix

整数

Prefix 是地址的前缀。

.spec.claimRef

描述

ClaimRef 是对为此 IPAddress 创建的声明的引用。

类型

对象

属性 类型 描述

name

字符串

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

.spec.poolRef

描述

PoolRef 是对此 IPAddress 创建的池的引用。

类型

对象

必需

  • kind

  • name

属性 类型 描述

apiGroup

字符串

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

kind

字符串

Kind 是被引用资源的类型

name

字符串

Name 是被引用资源的名称

API 端点

提供以下 API 端点

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

    • GET：列出 IPAddress 类型的对象

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

    • DELETE：删除 IPAddress 集合

    • GET：列出 IPAddress 类型的对象

    • POST：创建 IPAddress

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

    • DELETE：删除 IPAddress

    • GET：读取指定的 IPAddress

    • PATCH：部分更新指定的 IPAddress

    • PUT：替换指定的 IPAddress

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

HTTP 方法

GET

描述

列出 IPAddress 类型的对象

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

200 - OK

IPAddressList 模式

401 - 未授权

空

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

HTTP 方法

DELETE

描述

删除 IPAddress 集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 IPAddress 类型的对象

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

200 - OK

IPAddressList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 IPAddress

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

IPAddress 模式

201 - 已创建

IPAddress 模式

202 - 已接受

IPAddress 模式

401 - 未授权

空

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

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

name

字符串

IPAddress 的名称
HTTP 方法

DELETE

描述

删除 IPAddress

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 IPAddress

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

200 - OK

IPAddress 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 IPAddress

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

IPAddress 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 IPAddress

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

IPAddress 模式

201 - 已创建

IPAddress 模式

401 - 未授权

空