Deleting All PersistentVolumeClaims
Function
This API is used to delete all PersistentVolumeClaims.
URI
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
Table 1 describes the parameters of this API.
| Parameter | Mandatory | Description |
|---|---|---|
| namespace | Yes | Object name and auth scope, such as for teams and projects. |
| pretty | No | If 'true', then the output is pretty printed. |
| fieldSelector | No | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
| includeUninitialized | No | If true, partially initialized resources are included in the response. |
| labelSelector | No | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
| resourceVersion | No | 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 | No | Timeout for the list/watch call. |
| watch | No | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Request
N/A
Response
Response parameters:
For the description about response parameters, see Table 2.
Example response:
- The following is an example of a cluster of 1.15 or later:
{ "kind": "PersistentVolumeClaimList", "apiVersion": "v1", "metadata": { "selfLink": "/api/v1/namespaces/default/persistentvolumeclaims", "resourceVersion": "4203652" }, "items": [ { "metadata": { "name": "db-mysql", "namespace": "default", "selfLink": "/api/v1/namespaces/default/persistentvolumeclaims/db-mysql", "uid": "ac34af93-8cdd-11e8-8ee0-fa163e49263c", "resourceVersion": "4197709", "creationTimestamp": "2018-07-21T12:00:33Z", "labels": { "failure-domain.beta.kubernetes.io/region": "cn-north-4", "failure-domain.beta.kubernetes.io/zone": "cn-north-4a" }, "annotations": { "everest.io/crypt-key-id":"527cbece-428d-463b-a92c-936a11077b5d",// If the volume is encrypted, this parameter is displayed. "everest.io/disk-volume-type":"SATA", "pv.kubernetes.io/bind-completed": "yes", "pv.kubernetes.io/bound-by-controller": "yes", "volume.beta.kubernetes.io/storage-provisioner":"everest-csi-provisioner" } }, "spec": { "accessModes": [ "ReadWriteOnce" ], "resources": { "requests": { "storage": "10Gi" } }, "volumeName": "pvc-ac34af93-8cdd-11e8-8ee0-fa163e49263c", "storageClassName":"csi-disk", "volumeMode":"Filesystem" }, "status": { "phase": "Bound", "accessModes": [ "ReadWriteOnce" ], "capacity": { "storage": "10Gi" } } } ] } - Example for clusters of version 1.13 or earlier:
{ "kind": "PersistentVolumeClaimList", "apiVersion": "v1", "metadata": { "selfLink": "/api/v1/namespaces/default/persistentvolumeclaims", "resourceVersion": "4203652" }, "items": [ { "metadata": { "name": "db-mysql", "namespace": "default", "selfLink": "/api/v1/namespaces/default/persistentvolumeclaims/db-mysql", "uid": "ac34af93-8cdd-11e8-8ee0-fa163e49263c", "resourceVersion": "4197709", "creationTimestamp": "2018-07-21T12:00:33Z", "labels": { "failure-domain.beta.kubernetes.io/region": "cn-north-4", "failure-domain.beta.kubernetes.io/zone": "cn-north-4a" }, "annotations": { "pv.kubernetes.io/bind-completed": "yes", "pv.kubernetes.io/bound-by-controller": "yes", "volume.beta.kubernetes.io/storage-class": "sata", "volume.beta.kubernetes.io/storage-provisioner": "flexvolume-huawei.com/fuxivol" } }, "spec": { "accessModes": [ "ReadWriteMany" ], "resources": { "requests": { "storage": "10Gi" } }, "volumeName": "pvc-ac34af93-8cdd-11e8-8ee0-fa163e49263c", "volumeNamespace": "default" }, "status": { "phase": "Bound", "accessModes": [ "ReadWriteMany" ], "capacity": { "storage": "10Gi" } } } ] }
Status Code
Table 2 describes the status code of this API.
For the description about error status codes, see Status Code.
Last Article: Deleting a Specified PersistentVolumeClaim
Next Article: Reading a Specified PersistentVolumeClaim
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.