# VolumeAttachment

VolumeAttachmentVolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.apiVersion: storage.k8s.io/v1import "k8s.io/api/storage/v1"VolumeAttachmentVolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.VolumeAttachment objects are non-namespaced.apiVersion: storage.k8s.io/v1kind: VolumeAttachmentmetadata (ObjectMeta)Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (VolumeAttachmentSpec), requiredspec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.status (VolumeAttachmentStatus)status represents status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.VolumeAttachmentSpecVolumeAttachmentSpec is the specification of a VolumeAttachment request.attacher (string), requiredattacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().nodeName (string), requirednodeName represents the node that the volume should be attached to.source (VolumeAttachmentSource), requiredsource represents the volume that should be attached.VolumeAttachmentSource represents a volume that should be attached. Right now only PersistentVolumes can be attached via external attacher, in the future we may allow also inline volumes in pods. Exactly one member can be set.source.inlineVolumeSpec (PersistentVolumeSpec)inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature.source.persistentVolumeName (string)persistentVolumeName represents the name of the persistent volume to attach.VolumeAttachmentStatusVolumeAttachmentStatus is the status of a VolumeAttachment request.attached (boolean), requiredattached indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.attachError (VolumeError)attachError represents the last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.VolumeError captures an error encountered during a volume operation.attachError.errorCode (int32)errorCode is a numeric gRPC code representing the error encountered during Attach or Detach operations.This is an optional, beta field that requires the MutableCSINodeAllocatableCount feature gate being enabled to be set.attachError.message (string)message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.attachError.time (Time)time represents the time the error was encountered.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.attachmentMetadata (map[string]string)attachmentMetadata is populated with any information returned by the attach operation, upon successful attach, that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.detachError (VolumeError)detachError represents the last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.VolumeError captures an error encountered during a volume operation.detachError.errorCode (int32)errorCode is a numeric gRPC code representing the error encountered during Attach or Detach operations.This is an optional, beta field that requires the MutableCSINodeAllocatableCount feature gate being enabled to be set.detachError.message (string)message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.detachError.time (Time)time represents the time the error was encountered.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.VolumeAttachmentListVolumeAttachmentList is a collection of VolumeAttachment objects.apiVersion: storage.k8s.io/v1kind: VolumeAttachmentListmetadata (ListMeta)Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]VolumeAttachment), requireditems is the list of VolumeAttachmentsOperationsget read the specified VolumeAttachmentHTTP RequestGET /apis/storage.k8s.io/v1/volumeattachments/{name}Parametersname (in path): string, requiredname of the VolumeAttachmentpretty (in query): stringprettyResponse200 (VolumeAttachment): OK401: Unauthorizedget read status of the specified VolumeAttachmentHTTP RequestGET /apis/storage.k8s.io/v1/volumeattachments/{name}/statusParametersname (in path): string, requiredname of the VolumeAttachmentpretty (in query): stringprettyResponse200 (VolumeAttachment): OK401: Unauthorizedlist list or watch objects of kind VolumeAttachmentHTTP RequestGET /apis/storage.k8s.io/v1/volumeattachmentsParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (VolumeAttachmentList): OK401: Unauthorizedcreate create a VolumeAttachmentHTTP RequestPOST /apis/storage.k8s.io/v1/volumeattachmentsParametersbody: VolumeAttachment, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (VolumeAttachment): OK201 (VolumeAttachment): Created202 (VolumeAttachment): Accepted401: Unauthorizedupdate replace the specified VolumeAttachmentHTTP RequestPUT /apis/storage.k8s.io/v1/volumeattachments/{name}Parametersname (in path): string, requiredname of the VolumeAttachmentbody: VolumeAttachment, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (VolumeAttachment): OK201 (VolumeAttachment): Created401: Unauthorizedupdate replace status of the specified VolumeAttachmentHTTP RequestPUT /apis/storage.k8s.io/v1/volumeattachments/{name}/statusParametersname (in path): string, requiredname of the VolumeAttachmentbody: VolumeAttachment, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (VolumeAttachment): OK201 (VolumeAttachment): Created401: Unauthorizedpatch partially update the specified VolumeAttachmentHTTP RequestPATCH /apis/storage.k8s.io/v1/volumeattachments/{name}Parametersname (in path): string, requiredname of the VolumeAttachmentbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (VolumeAttachment): OK201 (VolumeAttachment): Created401: Unauthorizedpatch partially update status of the specified VolumeAttachmentHTTP RequestPATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/statusParametersname (in path): string, requiredname of the VolumeAttachmentbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (VolumeAttachment): OK201 (VolumeAttachment): Created401: Unauthorizeddelete delete a VolumeAttachmentHTTP RequestDELETE /apis/storage.k8s.io/v1/volumeattachments/{name}Parametersname (in path): string, requiredname of the VolumeAttachmentbody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (VolumeAttachment): OK202 (VolumeAttachment): Accepted401: Unauthorizeddeletecollection delete collection of VolumeAttachmentHTTP RequestDELETE /apis/storage.k8s.io/v1/volumeattachmentsParametersbody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.