PersistentVolumeClaim [core/v1] - core | API reference

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Specification
API endpoints

Description: PersistentVolumeClaim is a user’s request for and claim to a persistent volume
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`	PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
`.status`	`object`	PersistentVolumeClaimStatus is the current status of a persistent volume claim.

.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

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

.status

object

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

.spec

Description: PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
Type: object

Property Type Description

Property	Type	Description
`accessModes`	`array (string)`	AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
`resources`	`ResourceRequirements core/v1`	Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
`selector`	`LabelSelector meta/v1`	A label query over volumes to consider for binding.
`storageClassName`	`string`	Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
`volumeMode`	`string`	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is an alpha feature and may change in the future.
`volumeName`	`string`	VolumeName is the binding reference to the PersistentVolume backing this claim.

accessModes

array (string)

AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

resources

ResourceRequirements core/v1

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

selector

LabelSelector meta/v1

A label query over volumes to consider for binding.

storageClassName

string

Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeMode

string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is an alpha feature and may change in the future.

volumeName

string

VolumeName is the binding reference to the PersistentVolume backing this claim.

.status

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

Property Type Description

Property	Type	Description
`accessModes`	`array (string)`	AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
`capacity`	`object (Quantity api/resource)`	Represents the actual resources of the underlying volume.
`conditions`	`array (PersistentVolumeClaimCondition core/v1)`	Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
`phase`	`string`	Phase represents the current phase of PersistentVolumeClaim.

accessModes

array (string)

AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

capacity

object (Quantity api/resource)

Represents the actual resources of the underlying volume.

conditions

array (PersistentVolumeClaimCondition core/v1)

Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.

phase

string

Phase represents the current phase of PersistentVolumeClaim.

API endpoints

The following API endpoints are available:

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

/api/v1/persistentvolumeclaims

Table 1. Global guery 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.
`pretty`	`string`	If 'true', then the output is pretty printed.
`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.

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

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

/api/v1/namespaces/{namespace}/persistentvolumeclaims

Table 3. Global path parameters
Parameter	Type	Description
`namespace`	`string`	object name and auth scope, such as for teams and projects

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

HTTP method: DELETE
Description: delete collection of PersistentVolumeClaim

Table 5. 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 6. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

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

Table 7. 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 8. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolumeClaimList core/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a PersistentVolumeClaim

Table 9. Body parameters
Parameter	Type	Description
`body`	`PersistentVolumeClaim core/v1`

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

/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}

Table 11. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PersistentVolumeClaim
`namespace`	`string`	object name and auth scope, such as for teams and projects

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

HTTP method: DELETE
Description: delete a PersistentVolumeClaim

Table 13. 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 14. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

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

HTTP method: GET
Description: read the specified PersistentVolumeClaim

Table 16. 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 17. HTTP responses
HTTP code	Reponse body
200 - OK	`PersistentVolumeClaim core/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified PersistentVolumeClaim

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

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

HTTP method: PUT
Description: replace the specified PersistentVolumeClaim

Table 20. Body parameters
Parameter	Type	Description
`body`	`PersistentVolumeClaim core/v1`

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

/api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status

Table 22. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the PersistentVolumeClaim
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 23. 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 PersistentVolumeClaim

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

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

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

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

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

Table 27. Body parameters
Parameter	Type	Description
`body`	`PersistentVolumeClaim core/v1`

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