15.2. 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

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

HTTP 方法: GET
描述: 列出类型为 IPAddress 的对象

表 15.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`IPAddressList` schema
401 - Unauthorized	空

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

HTTP 方法: DELETE
描述: 删除 IPAddress 集合

表 15.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出类型为 IPAddress 的对象

表 15.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`IPAddressList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建一个 IPAddress

表 15.4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 15.5. 主体参数
参数	类型	描述
`正文（body）`	`ipaddress` 模式

表 15.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ipaddress` 模式
201 - Created	`ipaddress` 模式
202 - Accepted	`ipaddress` 模式
401 - Unauthorized	空

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

表 15.7. 全局路径参数
参数	类型	描述
`name`	`string`	IPAddress 的名称

HTTP 方法: DELETE
描述: 删除 IPAddress

表 15.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 15.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的 IPAddress

表 15.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ipaddress` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 IPAddress

表 15.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 15.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ipaddress` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 IPAddress

表 15.13. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 15.14. 主体参数
参数	类型	描述
`正文（body）`	`ipaddress` 模式

表 15.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ipaddress` 模式
201 - Created	`ipaddress` 模式
401 - Unauthorized	空

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

© 2024 Red Hat, Inc.