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 is to be discarded. Use the corresponding Kubernetes PVC API instead.
Calling Method
For details, see Calling APIs.
URI
DELETE /api/v1/namespaces/{namespace}/cloudpersistentvolumeclaims/{name}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
Name of a PVC to be deleted |
|
namespace |
Yes |
String |
Namespace where a PVC is located |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
deleteVolume |
No |
String |
Whether to delete associated backend cloud storage volume after a PVC is deleted. The value can be true or false and defaults to false. If it is set to true, it indicates that the associated backend cloud storage is deleted along with the PV. If it is set to false, it indicates that the associated backend cloud storage is not deleted along with the PV. |
|
storageType |
No |
String |
Cloud storage type. This parameter is used together with deleteVolume. This means that deleteVolume and storageType must be configured simultaneously. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
Content-Type |
Yes |
String |
Definition The request body type or format Constraints GET requests are not validated. Range Default Value N/A |
|
X-Auth-Token |
Yes |
String |
Definition 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 about how to obtain a token, see Authentication. Constraints N/A Range N/A Default Value N/A |
|
X-Cluster-ID |
No |
String |
Cluster ID, 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
|
Parameter |
Type |
Description |
|---|---|---|
|
apiVersion |
String |
API version. The value is fixed at v1. |
|
kind |
String |
API type. The value is fixed at PersistentVolumeClaim. |
|
metadata |
Cluster metadata, which is a collection of attributes |
|
|
spec |
PersistentVolumeClaimSpec object |
Detailed description of a cluster. 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. |
|
Parameter |
Type |
Description |
|---|---|---|
|
volumeID |
String |
ID of an existing storage volume. |
|
storageType |
String |
Cloud storage type, which is used together with volumeID. That means that volumeID and storageType must be configured concurrently. |
|
accessModes |
Array of strings |
Access mode of a volume. Only the first parameter in the list is valid.
|
|
storageClassName |
String |
Storage class name of a PVC |
|
volumeName |
String |
Name of the PV associated with a PVC |
|
resources |
ResourceRequirements object |
Resource requests and limits. |
|
volumeMode |
String |
PV type specified by a PVC |
Example Requests
N/A
Example Responses
N/A
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cce.v3.region.CceRegion; import com.huaweicloud.sdk.cce.v3.*; import com.huaweicloud.sdk.cce.v3.model.*; public class DeleteCloudPersistentVolumeClaimsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("<YOUR REGION>")) .build(); DeleteCloudPersistentVolumeClaimsRequest request = new DeleteCloudPersistentVolumeClaimsRequest(); request.withName("{name}"); request.withNamespace("{namespace}"); try { DeleteCloudPersistentVolumeClaimsResponse response = client.deleteCloudPersistentVolumeClaims(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcce.v3.region.cce_region import CceRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcce.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("<YOUR REGION>")) \ .build() try: request = DeleteCloudPersistentVolumeClaimsRequest() request.name = "{name}" request.namespace = "{namespace}" response = client.delete_cloud_persistent_volume_claims(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cce.NewCceClient( cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.DeleteCloudPersistentVolumeClaimsRequest{} request.Name = "{name}" request.Namespace = "{namespace}" response, err := client.DeleteCloudPersistentVolumeClaims(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in the API Explorer.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The job for deleting a PVC has been delivered. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot