Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> PersistentVolume> Deleting All PersistentVolumes
View PDF

Deleting All PersistentVolumes

Function

This API is used to delete all PersistentVolumes.

URI

DELETE /api/v1/persistentvolumes

Table 1 describes the parameters of this API.

Table 1 Parameter description

Parameter

Mandatory

Description

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 is 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:

{
    "kind": "PersistentVolumeList",
    "apiVersion": "v1",
    "metadata": {
        "selfLink": "/api/v1/persistentvolumes",
        "resourceVersion": "5679025"
    },
    "items": [
        {
            "metadata": {
                "name": "pv-test-02",
                "namespace": "default",
                "selfLink": "/api/v1/namespaces/default/persistentvolumes/pv-test-02",
                "uid": "b1e175a8-920c-11e8-8cd0-fa163e082286",
                "resourceVersion": "5675029",
                "creationTimestamp": "2018-07-28T02:19:45Z",
                "labels": {
                    "failure-domain.beta.kubernetes.io/region": "cn-north-4",
                    "failure-domain.beta.kubernetes.io/zone": "cn-north-4a",
                    "name": "pv-test-02"
                },
                "annotations": {
                    "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": {
                "capacity": {
                    "storage": "10Gi"
                },
                "hostPath": {
                    "path": "/home",
                    "type": ""
                },
                "accessModes": [
                    "ReadWriteMany"
                ],
                "claimRef": {
                    "kind": "PersistentVolumeClaim",
                    "namespace": "default",
                    "name": "db-mysql",
                    "uid": "638e26ac-9148-11e8-8cd0-fa163e082286",
                    "apiVersion": "v1",
                    "resourceVersion": "5674792"
                },
                "persistentVolumeReclaimPolicy": "Delete"
            },
            "status": {
                "phase": "Bound"
            }
        },
        {
            "metadata": {
                "name": "pv-test-03",
                "namespace": "default",
                "selfLink": "/api/v1/namespaces/default/persistentvolumes/pv-test-03",
                "uid": "e4e15446-920c-11e8-81cc-fa163e49263c",
                "resourceVersion": "5675754",
                "creationTimestamp": "2018-07-28T02:21:11Z",
                "labels": {
                    "failure-domain.beta.kubernetes.io/region": "cn-north-4",
                    "failure-domain.beta.kubernetes.io/zone": "cn-north-4a",
                    "name": "pv-test-03"
                },
                "annotations": {
                    "volume.beta.kubernetes.io/storage-class": "sata",
                    "volume.beta.kubernetes.io/storage-provisioner": "flexvolume-huawei.com/fuxivol"
                }
            },
            "spec": {
                "capacity": {
                    "storage": "3Gi"
                },
                "hostPath": {
                    "path": "/home",
                    "type": ""
                },
                "accessModes": [
                    "ReadWriteMany"
                ],
                "persistentVolumeReclaimPolicy": "Delete"
            },
            "status": {
                "phase": "Available"
            }
        }
    ]
}

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

Delete a DaemonSet resource object successfully.

For the description about error status codes, see Status Code.

Parent topic: PersistentVolume