×

规格

属性 类型 描述

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

对象

VolumeAttachmentSpec是VolumeAttachment请求的规范。

status

对象

VolumeAttachmentStatus是VolumeAttachment请求的状态。

.spec

描述

VolumeAttachmentSpec是VolumeAttachment请求的规范。

类型

对象

必需
  • attacher

  • source

  • nodeName

属性 类型 描述

attacher

字符串

attacher指示必须处理此请求的卷驱动程序的名称。这是GetPluginName()返回的名称。

nodeName

字符串

nodeName表示应将卷附加到的节点。

source

对象

VolumeAttachmentSource表示应附加的卷。目前,只有持久卷可以通过外部附加程序附加,将来我们也可能允许在pod中内联卷。只能设置一个成员。

.spec.source

描述

VolumeAttachmentSource表示应附加的卷。目前,只有持久卷可以通过外部附加程序附加,将来我们也可能允许在pod中内联卷。只能设置一个成员。

类型

对象

属性 类型 描述

inlineVolumeSpec

PersistentVolumeSpec

inlineVolumeSpec包含附加由pod的内联VolumeSource定义的持久卷所需的所有信息。此字段仅在CSIMigration功能中填充。它包含从pod的内联VolumeSource到PersistentVolumeSpec的转换字段。此字段为测试阶段,只有启用CSIMigration功能的服务器才会处理它。

persistentVolumeName

字符串

persistentVolumeName表示要附加的持久卷的名称。

.status

描述

VolumeAttachmentStatus是VolumeAttachment请求的状态。

类型

对象

必需
  • attached

属性 类型 描述

attachError

对象

VolumeError捕获在卷操作期间遇到的错误。

attached

布尔值

attached指示卷已成功附加。此字段只能由完成附加操作的实体(即外部附加程序)设置。

attachmentMetadata

对象(字符串)

attachmentMetadata填充了附加操作返回的任何信息(成功附加后),这些信息必须传递到后续的WaitForAttach或Mount调用中。此字段只能由完成附加操作的实体(即外部附加程序)设置。

detachError

对象

VolumeError捕获在卷操作期间遇到的错误。

.status.attachError

描述

VolumeError捕获在卷操作期间遇到的错误。

类型

对象

属性 类型 描述

message

字符串

message表示在附加或分离操作期间遇到的错误。此字符串可能会被记录,因此不应包含敏感信息。

time

时间

time表示遇到错误的时间。

.status.detachError

描述

VolumeError捕获在卷操作期间遇到的错误。

类型

对象

属性 类型 描述

message

字符串

message表示在附加或分离操作期间遇到的错误。此字符串可能会被记录,因此不应包含敏感信息。

time

时间

time表示遇到错误的时间。

API端点

提供以下API端点

  • /apis/storage.k8s.io/v1/volumeattachments

    • DELETE:删除VolumeAttachment集合

    • GET:列出或监视VolumeAttachment类型的对象

    • POST:创建一个VolumeAttachment

  • /apis/storage.k8s.io/v1/watch/volumeattachments

    • GET:监视对VolumeAttachment列表的单个更改。已弃用:改为使用列表操作的“watch”参数。

  • /apis/storage.k8s.io/v1/volumeattachments/{name}

    • DELETE:删除一个VolumeAttachment

    • GET:读取指定的VolumeAttachment

    • PATCH:部分更新指定的VolumeAttachment

    • PUT:替换指定的VolumeAttachment

  • /apis/storage.k8s.io/v1/watch/volumeattachments/{name}

    • GET:监视对VolumeAttachment类型对象的更改。已弃用:改为使用列表操作的“watch”参数,并使用“fieldSelector”参数过滤为单个项目。

  • /apis/storage.k8s.io/v1/volumeattachments/{name}/status

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

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

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

/apis/storage.k8s.io/v1/volumeattachments

HTTP方法

DELETE

描述

删除VolumeAttachment集合

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

dryRun

字符串

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

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

200 - OK

Status模式

401 - 未授权

HTTP方法

GET

描述

列出或监视VolumeAttachment类型的对象

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

200 - OK

VolumeAttachmentList模式

401 - 未授权

HTTP方法

POST

描述

创建一个VolumeAttachment

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

dryRun

字符串

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

fieldValidation

字符串

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

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

body

VolumeAttachment 模式

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

200 - OK

VolumeAttachment 模式

201 - 已创建

VolumeAttachment 模式

202 - 已接受

VolumeAttachment 模式

401 - 未授权

/apis/storage.k8s.io/v1/watch/volumeattachments

HTTP方法

GET

描述

监控 VolumeAttachment 列表的单个更改。已弃用:请改用列表操作中的“watch”参数。

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

200 - OK

WatchEvent 模式

401 - 未授权

/apis/storage.k8s.io/v1/volumeattachments/{name}

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

name

字符串

VolumeAttachment 的名称

HTTP方法

DELETE

描述

删除 VolumeAttachment

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

dryRun

字符串

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

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

200 - OK

VolumeAttachment 模式

202 - 已接受

VolumeAttachment 模式

401 - 未授权

HTTP方法

GET

描述

读取指定的 VolumeAttachment

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

200 - OK

VolumeAttachment 模式

401 - 未授权

HTTP方法

PATCH

描述

部分更新指定的 VolumeAttachment

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

VolumeAttachment 模式

201 - 已创建

VolumeAttachment 模式

401 - 未授权

HTTP方法

PUT

描述

替换指定的 VolumeAttachment

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

dryRun

字符串

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

fieldValidation

字符串

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

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

body

VolumeAttachment 模式

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

200 - OK

VolumeAttachment 模式

201 - 已创建

VolumeAttachment 模式

401 - 未授权

/apis/storage.k8s.io/v1/watch/volumeattachments/{name}

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

name

字符串

VolumeAttachment 的名称

HTTP方法

GET

描述

监控 VolumeAttachment 对象的更改。已弃用:请改用列表操作中的“watch”参数,并使用“fieldSelector”参数将其过滤为单个项目。

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

200 - OK

WatchEvent 模式

401 - 未授权

/apis/storage.k8s.io/v1/volumeattachments/{name}/status

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

name

字符串

VolumeAttachment 的名称

HTTP方法

GET

描述

读取指定的 VolumeAttachment 的状态

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

200 - OK

VolumeAttachment 模式

401 - 未授权

HTTP方法

PATCH

描述

部分更新指定的 VolumeAttachment 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

VolumeAttachment 模式

201 - 已创建

VolumeAttachment 模式

401 - 未授权

HTTP方法

PUT

描述

替换指定的 VolumeAttachment 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

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

body

VolumeAttachment 模式

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

200 - OK

VolumeAttachment 模式

201 - 已创建

VolumeAttachment 模式

401 - 未授权