Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> PersistentVolumeClaim> Listing All PersistentVolumeClaims
View PDF

Listing All PersistentVolumeClaims

Function

This API is used to list all PersistentVolumeClaims.

URI

GET /api/v1/persistentvolumeclaims

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.

labelSelector

No

A selector to restrict the list of returned objects by their labels. Defaults to everything.

includeUninitialized

No

If true, partially initialized resources are included in the response.

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.

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/persistentvolumeclaims",
        "resourceVersion":"2306215"
    },
    "items":[
        {
            "metadata":{
                "name":"cce-evs-k6m131jj-i1px",
                "namespace":"default",
                "selfLink":"/api/v1/namespaces/default/persistentvolumeclaims/cce-evs-k6m131jj-i1px",
                "uid":"d34f6a93-9eba-4a33-9320-8fa4addd3753",
                "resourceVersion":"2286592",
                "creationTimestamp":"2020-02-14T10:27:43Z",
                "labels":{
                    "failure-domain.beta.kubernetes.io/region":"cn-north-5",
                    "failure-domain.beta.kubernetes.io/zone":"cn-north-5a"
                },
                "annotations":{
                    "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"
                },
                "finalizers":[
                    "kubernetes.io/pvc-protection"
                ]
            },
            "spec":{
                "accessModes":[
                    "ReadWriteOnce"
                ],
                "resources":{
                    "requests":{
                        "storage":"10Gi"
                    }
                },
                "volumeName":"pvc-d34f6a93-9eba-4a33-9320-8fa4addd3753",
                "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/persistentvolumeclaims",
        "resourceVersion": "4199767"
    },
    "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"
                }
            }
        },
        {
            "metadata": {
                "name": "db-mysql-0",
                "namespace": "default",
                "selfLink": "/api/v1/namespaces/default/persistentvolumeclaims/db-mysql-0",
                "uid": "f6585eb2-8cdd-11e8-a538-fa163e082286",
                "resourceVersion": "4198033",
                "creationTimestamp": "2018-07-21T12:02:38Z",
                "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": "5Gi"
                    }
                },
                "volumeName": "pvc-f6585eb2-8cdd-11e8-a538-fa163e082286",
                "volumeNamespace": "default"
            },
            "status": {
                "phase": "Bound",
                "accessModes": [
                    "ReadWriteMany"
                ],
                "capacity": {
                    "storage": "5Gi"
                }
            }
        }
    ]
}

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

This operation succeeds, and a group of PersistentVolumeClaim resource objects is returned.

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

Parent topic: PersistentVolumeClaim