Updated on 2024-03-22 GMT+08:00

Deleting a PVC (to be discarded)

Function

This API is used to delete a PVC from a specified namespace. Using this API, you can determine whether to retain the cloud storage volume associated with the PVC. This API has been deprecated. Use the corresponding Kubernetes PV API instead.

The URL for storage management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cluster ID, and uri indicates the resource path, that is, the path for API access. If https://Endpoint/uri is used, the X-Cluster-ID parameter in the request header must be specified.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the PVC to be deleted.

namespace

Yes

String

Namespace where the PVC is located.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

deleteVolume

No

String

Whether to delete associated backend cloud storage volume after the PVC is deleted. The value can be true (delete) or false (not delete). The value defaults to false.

storageType

No

String

Cloud storage type. This parameter is used together with deleteVolume. That is, deleteVolume and storageType must be configured at the same time.

  • bs: EVS

  • nfs: SFS

  • obs: OBS

  • efs: SFS Turbo

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

X-Auth-Token

Yes

String

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

X-Cluster-ID

No

String

Cluster ID. This field is mandatory when the URL format https://Endpoint/uri is used. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

apiVersion

String

API version. The value is fixed at v1.

kind

String

API type. The value is fixed at PersistentVolumeClaim.

metadata

PersistentVolumeClaimMetadata object

Cluster object metadata, which is a collection of attributes.

spec

PersistentVolumeClaimSpec object

Detailed description of the cluster object. CCE creates or updates objects by defining or updating spec.

status

PersistentVolumeClaimStatus object

PVC status. The request to create a PVC does not need to carry this parameter.

Table 5 PersistentVolumeClaimMetadata

Parameter

Type

Description

name

String

PVC name. Enter 1 to 253 characters starting and ending with a letter or digit. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed. PVC names must be unique in a namespace.

labels

String

PVC labels, in the format of key-value pairs.

  • Key: Enter 1 to 63 characters, starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key and contain a maximum of 253 characters. Example DNS subdomain: example.com/my-key

  • Value: The value can be left blank or contain 1 to 63 characters that start with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed in the character string.

Table 6 PersistentVolumeClaimSpec

Parameter

Type

Description

volumeID

String

ID of an existing storage volume.

  • If an SFS, EVS, or SFS Turbo volume is used, set this parameter to the ID of the volume.

  • If an OBS bucket is used, set this parameter to the OBS bucket name.

storageType

String

Cloud storage class. This parameter is used together with volumeID. That is, volumeID and storageType must be configured at the same time.

  • bs: EVS

  • nfs: SFS

  • obs: OBS

  • efs: SFS Turbo

accessModes

Array of strings

Access mode of the volume. Only the first value in all selected options is valid.

  • ReadWriteOnce: The volume can be mounted as read-write by a single node.

    NOTE:

    This function is supported only when the cluster version is v1.13.10 and the storage-driver version is 1.0.19.

  • ReadOnlyMany (default): The volume can be mounted as read-only by many nodes.

  • ReadWriteMany: The volume can be mounted as read-write by many nodes.

storageClassName

String

Storage class name of the PVC.

volumeName

String

Name of the PV bound to the PVC.

resources

ResourceRequirements object

Resource requests and limits.

volumeMode

String

PV type specified by the PVC.

Table 7 ResourceRequirements

Parameter

Type

Description

limits

Map<String,String>

Resource limits. This parameter is invalid during creation.

requests

Map<String,String>

Resource requests. This parameter is invalid during creation.

Table 8 PersistentVolumeClaimStatus

Parameter

Type

Description

accessModes

Array of strings

Access mode of the PV.

capacity

String

Actual resources and capacity of the PV.

phase

String

Current status of the PVC.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The job for deleting a PVC is successfully delivered.

Error Codes

See Error Codes.