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

DataImage [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

对象

DataImageSpec 定义了 DataImage 的期望状态。

status

对象

DataImageStatus 定义了 DataImage 的观察状态。

.spec

描述

DataImageSpec 定义了 DataImage 的期望状态。

类型

对象

必需

  • url

属性 类型 描述

url

字符串

Url 是我们要附加到 BareMetalHost 的 dataImage 的地址

.status

描述

DataImageStatus 定义了 DataImage 的观察状态。

类型

对象

属性 类型 描述

attachedImage

对象

当前附加的DataImage

错误

对象

附加/分离时的错误计数和消息

上次协调时间

字符串

上次协调的时间

.status.attachedImage

描述

当前附加的DataImage

类型

对象

必需

  • url

属性 类型 描述

url

字符串

.status.error

描述

附加/分离时的错误计数和消息

类型

对象

必需

  • 计数

  • 消息

属性 类型 描述

计数

整数

消息

字符串

API端点

以下API端点可用

  • /apis/metal3.io/v1alpha1/dataimages

    • GET：列出DataImage类型的对象

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

    • DELETE：删除DataImage集合

    • GET：列出DataImage类型的对象

    • POST：创建DataImage

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

    • DELETE：删除DataImage

    • GET：读取指定的DataImage

    • PATCH：部分更新指定的DataImage

    • PUT：替换指定的DataImage

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

    • GET：读取指定的DataImage的状态

    • PATCH：部分更新指定的DataImage的状态

    • PUT：替换指定的DataImage的状态

/apis/metal3.io/v1alpha1/dataimages

HTTP方法

GET

描述

列出DataImage类型的对象

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

200 - OK

DataImageList模式

401 - 未授权

空

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

HTTP方法

DELETE

描述

删除DataImage集合

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

200 - OK

Status模式

401 - 未授权

空
HTTP方法

GET

描述

列出DataImage类型的对象

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

200 - OK

DataImageList模式

401 - 未授权

空
HTTP方法

POST

描述

创建DataImage

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

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

200 - OK

DataImage模式

201 - 已创建

DataImage模式

202 - 已接受

DataImage模式

401 - 未授权

空

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

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

name

字符串

DataImage的名称
HTTP方法

DELETE

描述

删除DataImage

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

dryRun

字符串

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

200 - OK

Status模式

202 - 已接受

Status模式

401 - 未授权

空
HTTP方法

GET

描述

读取指定的DataImage

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

200 - OK

DataImage模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的DataImage

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

DataImage模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的DataImage

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

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

200 - OK

DataImage模式

201 - 已创建

DataImage模式

401 - 未授权

空

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

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

name

字符串

DataImage的名称
HTTP方法

GET

描述

读取指定的DataImage的状态

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

200 - OK

DataImage模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的DataImage的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

DataImage模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的DataImage的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

DataImage模式
表22. HTTP响应
HTTP代码 响应体

200 - OK

DataImage模式

201 - 已创建

DataImage模式

401 - 未授权

空