OpenShift 文档正在迁移，不久后将仅在 docs.redhat.com（所有 Red Hat 产品文档的所在地）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

FirmwareSchema [metal3.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

对象

FirmwareSchemaSpec定义了FirmwareSchema的期望状态。

.spec

描述

FirmwareSchemaSpec定义了FirmwareSchema的期望状态。

类型

对象

必需

  • schema

属性 类型 描述

hardwareModel

字符串

与该模式关联的硬件型号

hardwareVendor

字符串

与该模式关联的硬件厂商

schema

对象

固件名称到模式的映射

schema{}

对象

描述固件设置的附加数据。

.spec.schema

描述

固件名称到模式的映射

类型

对象

.spec.schema{}

描述

描述固件设置的附加数据。

类型

对象

属性 类型 描述

allowable_values

数组（字符串）

枚举类型设置的允许值。

attribute_type

字符串

设置的类型。

lower_bound

整数

整数类型设置的最低值。

max_length

整数

字符串类型设置的最大长度。

min_length

整数

字符串类型设置的最小长度。

read_only

布尔值

此设置是否为只读。

unique

布尔值

此设置的值是否对此节点唯一，例如序列号。

upper_bound

整数

整数类型设置的最高值。

API端点

提供以下API端点

  • /apis/metal3.io/v1alpha1/firmwareschemas

    • GET：列出FirmwareSchema类型的对象

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas

    • DELETE：删除FirmwareSchema集合

    • GET：列出FirmwareSchema类型的对象

    • POST：创建一个FirmwareSchema

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}

    • DELETE：删除一个FirmwareSchema

    • GET：读取指定的FirmwareSchema

    • PATCH：部分更新指定的FirmwareSchema

    • PUT：替换指定的FirmwareSchema

/apis/metal3.io/v1alpha1/firmwareschemas

HTTP方法

GET

描述

列出FirmwareSchema类型的对象

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

200 - OK

FirmwareSchemaList 模式

401 - 未授权

空

/apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas

HTTP方法

DELETE

描述

删除FirmwareSchema集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

列出FirmwareSchema类型的对象

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

200 - OK

FirmwareSchemaList 模式

401 - 未授权

空
HTTP方法

POST

描述

创建一个FirmwareSchema

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

FirmwareSchema 模式

201 - 已创建

FirmwareSchema 模式

202 - 已接受

FirmwareSchema 模式

401 - 未授权

空

/apis/metal3.io/v1alpha1/namespaces/{namespace}/firmwareschemas/{name}

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

name

字符串

FirmwareSchema的名称
HTTP方法

DELETE

描述

删除一个FirmwareSchema

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

读取指定的FirmwareSchema

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

200 - OK

FirmwareSchema 模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的FirmwareSchema

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

FirmwareSchema 模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的FirmwareSchema

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

FirmwareSchema 模式

201 - 已创建

FirmwareSchema 模式

401 - 未授权

空