Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> PersistentVolumeClaim> Replacing a Specified PersistentVolumeClaim
View PDF

Replacing a Specified PersistentVolumeClaim

Function

This API is used to replace a PersistentVolumeClaim in a specified namespace.

The following fields can be updated:

  • metadata.labels
  • metadata.generateName

URI

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

Table 1 describes the parameters of this API.

Table 1 Parameter description

Parameter

Mandatory

Description

name

Yes

Name of the PersistentVolumeClaim.

namespace

Yes

Object name and auth scope, such as for teams and projects.

pretty

No

If 'true', then the output is pretty printed.

Request

Request parameters:

For the description about request parameters, see Table 2.

Example request:

  • The following is an example of a cluster of 1.15 or later: 
    {
    "kind":"PersistentVolumeClaim",
    "apiVersion":"v1",
    "metadata":{
        "name":"cce-evs-k6m131jj-i1px",
        "namespace":"default",
        "selfLink":"/api/v1/namespaces/default/persistentvolumeclaims/cce-evs-k6m131jj-i1px",
        "uid":"d34f6a93-9eba-4a33-9320-8fa4addd3753",
        "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"
    }
}
  • Example YAML file for clusters of version 1.13 or earlier: 
    {
    "kind": "PersistentVolumeClaim",
    "apiVersion": "v1",
    "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",
            "app":"mysql"
        },
        "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"
        }
    }
}

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":"PersistentVolumeClaim",
    "apiVersion":"v1",
    "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": "PersistentVolumeClaim",
    "apiVersion": "v1",
    "metadata": {
        "name": "db-mysql-0",
        "namespace": "default",
        "selfLink": "/api/v1/namespaces/default/persistentvolumeclaims/db-mysql-0",
        "uid": "f6585eb2-8cdd-11e8-a538-fa163e082286",
        "resourceVersion": "4201550",
        "creationTimestamp": "2018-07-21T12:02:38Z",
        "labels": {
            "app": "mysql",
            "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 PersistentVolumeClaim resource object is returned.

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

Parent topic: PersistentVolumeClaim