Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> PersistentVolumeClaim> Listing PersistentVolumeClaims in a Specified Namespace
View PDF

Listing PersistentVolumeClaims in a Specified Namespace

Function

This API is used to list all PersistentVolumeClaims in a specified namespace.

URI

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

Table 1 describes the parameters of this API.

Table 1 Parameter description

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.

includeUninitialized

No

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

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.

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:

Table 2 Response parameter

Parameter

Type

Description

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.

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.

metadata

metadata object

Standard list metadata.

items

Object

A list of persistent volume claims.

For details, see Table 2.
Table 3 Data structure of the metadata field

Parameter

Type

Description

resourceVersion

String

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only.

selfLink

String

SelfLink is a URL representing this object. Populated by the system. Read-only.

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/namespaces/default/persistentvolumeclaims",
        "resourceVersion": "4198037"
    },
    "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"
                }
            }
        }
    ]
}
Parent topic: PersistentVolumeClaim