3.2. API 端点

可用的 API 端点如下：

/apis/metal3.io/v1alpha1/baremetalhosts
- GET: 列出 BareMetalHost 类型的对象
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts
- DELETE: 删除 BareMetalHost 集合
- GET: 列出 BareMetalHost 类型的对象
- POST ：创建 BareMetalHost
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}
- DELETE ：删除 BareMetalHost
- GET ：读取指定的 BareMetalHost
- PATCH: 部分更新指定的 BareMetalHost
- PUT ：替换指定的 BareMetalHost
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status
- GET ：指定 BareMetalHost 的读取状态
- PATCH: 部分更新指定 BareMetalHost 的状态
- PUT ：替换指定 BareMetalHost 的状态

3.2.1. /apis/metal3.io/v1alpha1/baremetalhosts

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

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

3.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts

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

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

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

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

HTTP 方法: POST
描述: 创建 BareMetalHost

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

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

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

3.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}

表 3.7. 全局路径参数
参数	类型	描述
`name`	`字符串`	BareMetalHost 的名称

HTTP 方法: DELETE
描述: 删除 BareMetalHost

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

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

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

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

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

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

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

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

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

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

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

3.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status

表 3.16. 全局路径参数
参数	类型	描述
`name`	`字符串`	BareMetalHost 的名称

HTTP 方法: GET
描述: 指定 BareMetalHost 的读取状态

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

HTTP 方法: PATCH
描述: 部分更新指定 BareMetalHost 的状态

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

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

HTTP 方法: PUT
描述: 替换指定 BareMetalHost 的状态

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

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

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

3.2. API 端点

3.2.1. /apis/metal3.io/v1alpha1/baremetalhosts

3.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts

3.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}

3.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links