Help Center> Cloud Container Instance (CCI)> API Reference> Kubernetes-native APIs> PersistentVolumeClaim> Deleting a PersistentVolumeClaim
View PDF

Deleting a PersistentVolumeClaim

Function

This API is used to delete a Persistent Volume Claim (PVC).

URI

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

Table 1 Path parameters

Parameter

Description

namespace

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

name

Name of the PersistentVolumeClaim.
Table 2 Query parameters

Parameter

Mandatory

Description

pretty

No

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

gracePeriodSeconds

No

The duration in seconds before the object should be deleted. Value must be a non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. The value 0 indicates to delete immediately.

orphanDependents

No

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

No

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Orphan - orphan the dependents

Background - allow the garbage collector to delete the dependents in the background

Foreground - a cascading policy that deletes all dependents in the foreground

Request

Request parameters

For the description about request parameters, see Table 64.

Example request

{
    "kind": "DeleteOptions",
    "apiVersion": "v1",
    "gracePeriodSeconds": 0
}

Response

Response parameters

For the description about response parameters, see Table 72.

Example response

{
    "kind": "PersistentVolumeClaim",
    "apiVersion": "v1",
    "metadata": {
        "name": "pvc-test",
        "namespace": "namespace-test",
        "selfLink": "/api/v1/namespaces/namespace-test/persistentvolumeclaims/pvc-test",
        "uid": "5a9ab4c1-b1a6-11e8-8b84-c88d83be759f",
        "resourceVersion": "5669396",
        "creationTimestamp": "2018-09-06T07:27:47Z",
        "deletionTimestamp": "2018-09-06T07:51:51Z",
        "deletionGracePeriodSeconds": 0,
        "annotations": {
            "volume.beta.kubernetes.io/storage-class": "sata",
            "volume.beta.kubernetes.io/storage-provisioner": "flexvolume-huawei.com/fuxivol"
        },
        "finalizers": [
            "kubernetes.io/pvc-protection"
        ],
        "enable": true
    },
    "spec": {
        "accessModes": [
            "ReadWriteMany"
        ],
        "resources": {
            "requests": {
                "storage": "10Gi"
            }
        }
    },
    "status": {
        "phase": "Pending"
    }
}

Status Code

Table 3 describes the status code of this API.

Table 3 Status code

Status Code

Description

200

A PersistentVolumeClaim resource object is deleted successfully.

For more status codes, see Status Codes.

Parent topic: PersistentVolumeClaim