PersistentVolume [core/v1] - core | API reference

Specification
API endpoints

Description: PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
Type: object

Specification

Property Type Description

Property	Type	Description
`.apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
`.kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
`.spec`	`object`	PersistentVolumeSpec is the specification of a persistent volume.
`.status`	`object`	PersistentVolumeStatus is the current status of a persistent volume.

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

.spec

object

PersistentVolumeSpec is the specification of a persistent volume.

.status

object

PersistentVolumeStatus is the current status of a persistent volume.

.spec

Description: PersistentVolumeSpec is the specification of a persistent volume.
Type: object

Property Type Description

Property	Type	Description
`accessModes`	`array (string)`	AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
`awsElasticBlockStore`	`AWSElasticBlockStoreVolumeSource core/v1`	AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
`azureDisk`	`AzureDiskVolumeSource core/v1`	AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
`azureFile`	`AzureFilePersistentVolumeSource core/v1`	AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
`capacity`	`object (Quantity api/resource)`	A description of the persistent volume’s resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
`cephfs`	`CephFSPersistentVolumeSource core/v1`	CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime
`cinder`	`CinderPersistentVolumeSource core/v1`	Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
`claimRef`	`ObjectReference core/v1`	ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
`csi`	`CSIPersistentVolumeSource core/v1`	CSI represents storage that handled by an external CSI driver (Beta feature).
`fc`	`FCVolumeSource core/v1`	FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.
`flexVolume`	`FlexPersistentVolumeSource core/v1`	FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
`flocker`	`FlockerVolumeSource core/v1`	Flocker represents a Flocker volume attached to a kubelet’s host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
`gcePersistentDisk`	`GCEPersistentDiskVolumeSource core/v1`	GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
`glusterfs`	`GlusterfsVolumeSource core/v1`	Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
`hostPath`	`HostPathVolumeSource core/v1`	HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
`iscsi`	`ISCSIPersistentVolumeSource core/v1`	ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin.
`local`	`LocalVolumeSource core/v1`	Local represents directly-attached storage with node affinity
`mountOptions`	`array (string)`	A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
`nfs`	`NFSVolumeSource core/v1`	NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
`nodeAffinity`	`VolumeNodeAffinity core/v1`	NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
`persistentVolumeReclaimPolicy`	`string`	What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
`photonPersistentDisk`	`PhotonPersistentDiskVolumeSource core/v1`	PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
`portworxVolume`	`PortworxVolumeSource core/v1`	PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
`quobyte`	`QuobyteVolumeSource core/v1`	Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime
`rbd`	`RBDPersistentVolumeSource core/v1`	RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
`scaleIO`	`ScaleIOPersistentVolumeSource core/v1`	ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
`storageClassName`	`string`	Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
`storageos`	`StorageOSPersistentVolumeSource core/v1`	StorageOS represents a StorageOS volume that is attached to the kubelet’s host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md
`volumeMode`	`string`	volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is an alpha feature and may change in the future.
`vsphereVolume`	`VsphereVirtualDiskVolumeSource core/v1`	VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

accessModes

array (string)

AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

awsElasticBlockStore

AWSElasticBlockStoreVolumeSource core/v1

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

AzureDiskVolumeSource core/v1

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

azureFile

AzureFilePersistentVolumeSource core/v1

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

capacity

object (Quantity api/resource)

A description of the persistent volume’s resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

cephfs

CephFSPersistentVolumeSource core/v1

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

cinder

CinderPersistentVolumeSource core/v1

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

claimRef

ObjectReference core/v1

ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding

csi

CSIPersistentVolumeSource core/v1

CSI represents storage that handled by an external CSI driver (Beta feature).

fc

FCVolumeSource core/v1

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

flexVolume

FlexPersistentVolumeSource core/v1

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

flocker

FlockerVolumeSource core/v1

Flocker represents a Flocker volume attached to a kubelet’s host machine and exposed to the pod for its usage. This depends on the Flocker control service being running

gcePersistentDisk

GCEPersistentDiskVolumeSource core/v1

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

glusterfs

GlusterfsVolumeSource core/v1

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

hostPath

HostPathVolumeSource core/v1

HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

iscsi

ISCSIPersistentVolumeSource core/v1

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin.

local

LocalVolumeSource core/v1

Local represents directly-attached storage with node affinity

mountOptions

array (string)

A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

nfs

NFSVolumeSource core/v1

NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

nodeAffinity

VolumeNodeAffinity core/v1

NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.

persistentVolumeReclaimPolicy

string

What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

photonPersistentDisk

PhotonPersistentDiskVolumeSource core/v1

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

portworxVolume

PortworxVolumeSource core/v1

PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

quobyte

QuobyteVolumeSource core/v1

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

rbd

RBDPersistentVolumeSource core/v1

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

scaleIO

ScaleIOPersistentVolumeSource core/v1

ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

storageClassName

string

Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.

storageos

StorageOSPersistentVolumeSource core/v1

StorageOS represents a StorageOS volume that is attached to the kubelet’s host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md

volumeMode

string

volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is an alpha feature and may change in the future.

vsphereVolume

VsphereVirtualDiskVolumeSource core/v1

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

.status

Description: PersistentVolumeStatus is the current status of a persistent volume.
Type: object

Property Type Description

Property	Type	Description
`message`	`string`	A human-readable message indicating details about why the volume is in this state.
`phase`	`string`	Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
`reason`	`string`	Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

message

string

A human-readable message indicating details about why the volume is in this state.

phase

string

Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase

reason

string

Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

API endpoints

The following API endpoints are available:

/api/v1/persistentvolumes
- DELETE: delete collection of PersistentVolume
- GET: list or watch objects of kind PersistentVolume
- POST: create a PersistentVolume
/api/v1/persistentvolumes/{name}
- DELETE: delete a PersistentVolume
- GET: read the specified PersistentVolume
- PATCH: partially update the specified PersistentVolume
- PUT: replace the specified PersistentVolume
/api/v1/persistentvolumes/{name}/status
- GET: read status of the specified PersistentVolume
- PATCH: partially update status of the specified PersistentVolume
- PUT: replace status of the specified PersistentVolume

/api/v1/persistentvolumes

Table 1. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of PersistentVolume

Table 2. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind PersistentVolume

Table 4. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolumeList core/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a PersistentVolume

Table 6. Body parameters
Parameter	Type	Description
`body`	`PersistentVolume core/v1`

Table 7. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolume core/v1`
201 - Created	`PersistentVolume core/v1`
202 - Accepted	`PersistentVolume core/v1`
401 - Unauthorized	Empty

/api/v1/persistentvolumes/{name}

Table 8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PersistentVolume

Table 9. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a PersistentVolume

Table 10. Query parameters
Parameter	Type	Description
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 11. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 12. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified PersistentVolume

Table 13. Query parameters
Parameter	Type	Description
`exact`	`boolean`	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
`export`	`boolean`	Should this value be exported. Export strips fields that a user can not specify.

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolume core/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified PersistentVolume

Table 15. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolume core/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified PersistentVolume

Table 17. Body parameters
Parameter	Type	Description
`body`	`PersistentVolume core/v1`

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolume core/v1`
201 - Created	`PersistentVolume core/v1`
401 - Unauthorized	Empty

/api/v1/persistentvolumes/{name}/status

Table 19. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PersistentVolume

Table 20. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read status of the specified PersistentVolume

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolume core/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified PersistentVolume

Table 22. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 23. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolume core/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified PersistentVolume

Table 24. Body parameters
Parameter	Type	Description
`body`	`PersistentVolume core/v1`

Table 25. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolume core/v1`
201 - Created	`PersistentVolume core/v1`
401 - Unauthorized	Empty