Cancelamento da exclusão programada de uma CMK
Função
Essa API é usada para cancelar a exclusão programada de uma CMK.
Restrições
Você pode cancelar a exclusão agendada de uma CMK somente quando o status da CMK for exclusão programada.
URI
POST /v1.0/{project_id}/kms/cancel-key-deletion
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. O token pode ser obtido chamando a API do IAM (valor de X-Subject-Token no cabeçalho de resposta). |
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
key_id |
Sim |
String |
ID de CMK. Deve ter 36 bytes e corresponder à expressão regular ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Exemplo: 0d0466b0-e727-4d9c-b35d-f84bb474a37f |
sequence |
Não |
String |
Número de sequência de 36-byte de uma mensagem de solicitação. Exemplo: 919c82d4-8046-4722-9094-35c3c6524cff |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
key_id |
String |
ID de CMK. |
key_state |
String |
Estado de chave. Pode ser:
|
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Object |
Mensagem de erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Informação de erro. |
Código de status: 403
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Object |
Mensagem de erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Informação de erro. |
Código de status: 404
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Object |
Mensagem de erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Informação de erro. |
Exemplo de solicitações
{ "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f" }
Exemplo de respostas
Código de status: 200
Processamento da solicitação bem-sucedido.
{ "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "key_state" : "3" }
Código de status: 400
Parâmetros de solicitação inválidos.
{ "error" : { "error_code" : "KMS.XXX", "error_msg" : "XXX" } }
Código de status: 403
Autenticação falhou.
{ "error" : { "error_code" : "KMS.XXX", "error_msg" : "XXX" } }
Código de status: 404
O recurso solicitado não existe ou não foi encontrado.
{ "error" : { "error_code" : "KMS.XXX", "error_msg" : "XXX" } }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Processamento da solicitação bem-sucedido. |
400 |
Parâmetros de solicitação inválidos. |
403 |
Autenticação falhou. |
404 |
O recurso solicitado não existe ou não foi encontrado. |
Códigos de erro
Consulte Códigos de erro.