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

IPPool [whereabouts.cni.cncf.io/v1alpha1]

规范

属性 类型 描述

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

对象

IPPoolSpec定义了IPPool的期望状态

.spec

描述

IPPoolSpec定义了IPPool的期望状态

类型

对象

必需

  • allocations

  • 范围

属性 类型 描述

allocations

对象

Allocations是给定范围内的已分配IP集。它的索引与池范围的相同索引/偏移量的IP直接映射。

allocations{}

对象

IPAllocation表示特定IP的Pod/容器所有者的元数据

范围

字符串

Range是一个RFC 4632/4291风格的字符串，它以CIDR表示法表示IP地址和前缀长度。

.spec.allocations

描述

Allocations是给定范围内的已分配IP集。它的索引与池范围的相同索引/偏移量的IP直接映射。

类型

对象

.spec.allocations{}

描述

IPAllocation表示特定IP的Pod/容器所有者的元数据

类型

对象

必需

  • id

  • podref

属性 类型 描述

id

字符串

ifname

字符串

podref

字符串

API端点

提供以下API端点

  • /apis/whereabouts.cni.cncf.io/v1alpha1/ippools

    • GET：列出IPPool类型的对象

  • /apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/ippools

    • DELETE：删除IPPool集合

    • GET：列出IPPool类型的对象

    • POST：创建一个IPPool

  • /apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/ippools/{name}

    • DELETE：删除一个IPPool

    • GET：读取指定的IPPool

    • PATCH：部分更新指定的IPPool

    • PUT：替换指定的IPPool

/apis/whereabouts.cni.cncf.io/v1alpha1/ippools

HTTP方法

GET

描述

列出IPPool类型的对象

表1. HTTP响应
HTTP代码 响应正文

200 - OK

IPPoolList 模式

401 - 未授权

空

/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/ippools

HTTP方法

DELETE

描述

删除IPPool集合

表2. HTTP响应
HTTP代码 响应正文

200 - OK

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

列出IPPool类型的对象

表 3. HTTP 响应
HTTP代码 响应正文

200 - OK

IPPoolList 模式

401 - 未授权

空
HTTP方法

POST

描述

创建 IPPool

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

dryRun

字符串

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

fieldValidation

字符串

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

body

IPPool 模式
表 6. HTTP 响应
HTTP代码 响应正文

200 - OK

IPPool 模式

201 - 已创建

IPPool 模式

202 - 已接受

IPPool 模式

401 - 未授权

空

/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/ippools/{name}

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

name

字符串

IPPool 的名称
HTTP方法

DELETE

描述

删除 IPPool

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

读取指定的 IPPool

表 10. HTTP 响应
HTTP代码 响应正文

200 - OK

IPPool 模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的 IPPool

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

IPPool 模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的 IPPool

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

dryRun

字符串

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

fieldValidation

字符串

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

body

IPPool 模式
表 15. HTTP 响应
HTTP代码 响应正文

200 - OK

IPPool 模式

201 - 已创建

IPPool 模式

401 - 未授权

空