Exclusão de uma PVC (a ser descartada)
Função
Essa API é usada para excluir uma PVC de um namespace especificado. Usando essa API, você pode determinar se deve reter o volume de armazenamento em nuvem associado à PVC. Esta API foi preterida. Em vez disso, use a API PV do Kubernetes correspondente.
O URL para gerenciamento de armazenamento está no formato https://{clusterid}.Endpoint/uri. No URL, {clusterid} indica o ID do cluster e uri indica o caminho do recurso, ou seja, o caminho para acesso à API. Se https://Endpoint/uri for usado, o parâmetro X-Cluster-ID no cabeçalho da solicitação deve ser especificado.
URI
DELETE /api/v1/namespaces/{namespace}/cloudpersistentvolumeclaims/{name}
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
name |
Sim |
String |
Nome da PVC a ser excluída. |
|
namespace |
Sim |
String |
Namespace onde a PVC está localizada. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
deleteVolume |
Não |
String |
Se excluir o volume de armazenamento em nuvem de back-end associado após a exclusão da PVC. O valor pode ser true (delete) ou false (não delete). O valor padrão é false. |
|
storageType |
Não |
String |
Tipo de armazenamento em nuvem. Este parâmetro é utilizado em conjunto com deleteVolume. Ou seja, deleteVolume e storageType devem ser configurados ao mesmo tempo.
|
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
Content-Type |
Sim |
String |
Tipo de corpo da mensagem (formato). |
|
X-Auth-Token |
Sim |
String |
As solicitações para chamar uma API podem ser autenticadas usando um token ou AK/SK. Se a autenticação baseada em token for usada, esse parâmetro é obrigatório e deve ser definido como um token de usuário. Para obter detalhes, consulte Obtenção de um token de usuário. |
|
X-Cluster-ID |
Não |
String |
ID do cluster. Este parâmetro é obrigatório quando o formato de URL https://Endpoint/uri é usado. Para obter detalhes sobre como obter o valor, consulte Como obter parâmetros no URI da API. |
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
apiVersion |
String |
Versão da API. O valor é fixado em v1. |
|
kind |
String |
Tipo de API. O valor é fixado em PersistentVolumeClaim. |
|
metadata |
Metadados de objeto de cluster, que é uma coleção de atributos. |
|
|
spec |
PersistentVolumeClaimSpec object |
Descrição detalhada do objeto de cluster. O CCE cria ou atualiza objetos definindo ou atualizando spec. |
|
status |
PersistentVolumeClaimStatus object |
Estado da PVC. A solicitação para criar uma PVC não precisa carregar esse parâmetro. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
name |
String |
Nome da PVC. Digite de 1 a 253 caracteres começando e terminando com uma letra ou dígito. Use somente letras minúsculas, dígitos, hifens (-) e pontos finais (.). Nomes da PVC devem ser exclusivos em um namespace. |
|
labels |
String |
Rótulos da PVC, no formato de pares chave-valor.
|
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
volumeID |
String |
ID de um volume de armazenamento existente.
|
|
storageType |
String |
Classe de armazenamento em nuvem. Este parâmetro é usado em conjunto com volumeID. Ou seja, volumeID e storageType devem ser configurados ao mesmo tempo.
|
|
accessModes |
Array of strings |
Modo de acesso do volume. Somente o primeiro valor em todas as opções selecionadas é válido.
|
|
storageClassName |
String |
Nome da classe de armazenamento da PVC. |
|
volumeName |
String |
Nome do PV vinculado à PVC. |
|
resources |
ResourceRequirements object |
Solicitações e limites de recursos. |
|
volumeMode |
String |
Tipo PV especificado pela PVC. |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Nenhum
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
A tarefa para excluir uma PVC é entregue com êxito. |
Códigos de erro
Consulte Códigos de erro.