×

规范

属性 类型 描述

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

对象

Metal3RemediationTemplateSpec定义了Metal3RemediationTemplate的期望状态。

status

对象

Metal3RemediationTemplateStatus定义了Metal3RemediationTemplate的观察状态。

.spec

描述

Metal3RemediationTemplateSpec定义了Metal3RemediationTemplate的期望状态。

类型

对象

必需
  • template

属性 类型 描述

template

对象

Metal3RemediationTemplateResource描述了从模板创建Metal3Remediation所需的数据。

.spec.template

描述

Metal3RemediationTemplateResource描述了从模板创建Metal3Remediation所需的数据。

类型

对象

必需
  • spec

属性 类型 描述

spec

对象

Spec是Metal3Remediation期望行为的规范。

.spec.template.spec

描述

Spec是Metal3Remediation期望行为的规范。

类型

对象

属性 类型 描述

strategy

对象

Strategy字段定义了补救策略。

.spec.template.spec.strategy

描述

Strategy字段定义了补救策略。

类型

对象

属性 类型 描述

retryLimit

整数

设置最大补救重试次数。

timeout

字符串

设置补救重试之间的超时时间。

type

字符串

补救类型。

.status

描述

Metal3RemediationTemplateStatus定义了Metal3RemediationTemplate的观察状态。

类型

对象

必需
  • status

属性 类型 描述

status

对象

Metal3RemediationStatus定义了Metal3Remediation的观察状态

.status.status

描述

Metal3RemediationStatus定义了Metal3Remediation的观察状态

类型

对象

属性 类型 描述

lastRemediated

字符串

LastRemediated标识上次修复主机的时间

phase

字符串

Phase表示机器修复的当前阶段。例如,Pending、Running、Done等。

retryCount

整数

RetryCount可在修复期间用作计数器。字段可以保存重启次数等。

API端点

提供以下API端点

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

    • GET:列出Metal3RemediationTemplate类型的对象

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates

    • DELETE:删除Metal3RemediationTemplate集合

    • GET:列出Metal3RemediationTemplate类型的对象

    • POST:创建一个Metal3RemediationTemplate

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}

    • DELETE:删除一个Metal3RemediationTemplate

    • GET:读取指定的Metal3RemediationTemplate

    • PATCH:部分更新指定的Metal3RemediationTemplate

    • PUT:替换指定的Metal3RemediationTemplate

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

    • GET:读取指定的Metal3RemediationTemplate的状态

    • PATCH:部分更新指定的Metal3RemediationTemplate的状态

    • PUT:替换指定的Metal3RemediationTemplate的状态

/apis/infrastructure.cluster.x-k8s.io/v1beta1/metal3remediationtemplates

HTTP方法

GET

描述

列出Metal3RemediationTemplate类型的对象

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

200 - OK

Metal3RemediationTemplateList模式

401 - 未授权

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates

HTTP方法

DELETE

描述

删除Metal3RemediationTemplate集合

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

200 - OK

Status模式

401 - 未授权

HTTP方法

GET

描述

列出Metal3RemediationTemplate类型的对象

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

200 - OK

Metal3RemediationTemplateList模式

401 - 未授权

HTTP方法

POST

描述

创建一个Metal3RemediationTemplate

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

dryRun

字符串

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

fieldValidation

字符串

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

表 5. 请求体参数
参数 类型 描述

body

Metal3RemediationTemplate 模式

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

200 - OK

Metal3RemediationTemplate 模式

201 - 已创建

Metal3RemediationTemplate 模式

202 - 已接受

Metal3RemediationTemplate 模式

401 - 未授权

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}

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

name

字符串

Metal3RemediationTemplate 的名称

HTTP方法

DELETE

描述

删除 Metal3RemediationTemplate

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

dryRun

字符串

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

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

200 - OK

Status模式

202 - 已接受

Status模式

401 - 未授权

HTTP方法

GET

描述

读取指定的 Metal3RemediationTemplate

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

200 - OK

Metal3RemediationTemplate 模式

401 - 未授权

HTTP方法

PATCH

描述

部分更新指定的 Metal3RemediationTemplate

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

Metal3RemediationTemplate 模式

401 - 未授权

HTTP方法

PUT

描述

替换指定的 Metal3RemediationTemplate

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

dryRun

字符串

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

fieldValidation

字符串

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

表 14. 请求体参数
参数 类型 描述

body

Metal3RemediationTemplate 模式

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

200 - OK

Metal3RemediationTemplate 模式

201 - 已创建

Metal3RemediationTemplate 模式

401 - 未授权

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/metal3remediationtemplates/{name}/status

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

name

字符串

Metal3RemediationTemplate 的名称

HTTP方法

GET

描述

读取指定的 Metal3RemediationTemplate 的状态

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

200 - OK

Metal3RemediationTemplate 模式

401 - 未授权

HTTP方法

PATCH

描述

部分更新指定的 Metal3RemediationTemplate 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

Metal3RemediationTemplate 模式

401 - 未授权

HTTP方法

PUT

描述

替换指定的 Metal3RemediationTemplate 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

表 21. 请求体参数
参数 类型 描述

body

Metal3RemediationTemplate 模式

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

200 - OK

Metal3RemediationTemplate 模式

201 - 已创建

Metal3RemediationTemplate 模式

401 - 未授权