Ativação ou desativação do backup criptografado
Função
Essa API é usada para ativar ou desativar o backup criptografado. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
POST /v3/{project_id}/instances/{instance_id}/backups/encryption
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário em uma região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
instance_id |
Sim |
String |
ID de instância de um locatário em um projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
type |
Não |
String |
Tipo de criptografia. Atualmente, somente kms (sem distinção entre maiúsculas e minúsculas) é suportado. Esse parâmetro é obrigatório quando o backup criptografado está ativado e não é necessário quando o backup criptografado está desativado. |
kms_key_id |
Não |
String |
ID do KMS. Esse parâmetro é obrigatório quando o backup criptografado está ativado e não é necessário quando o backup criptografado está desativado. Para obter o valor, consulte o parâmetro de resposta key_id na API para criação de uma chave. |
encryption_status |
Sim |
String |
Se deve ativar ou desativar o backup criptografado. Valor:
|
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
encryption_status |
String |
Se o backup criptografado está ativado ou desativado. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
- Ativação de backup criptografado
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption { "type" : "kms", "kms_key_id" : "b82fa43f-f6e8-4ec4-9c31-231bc547c526", "encryption_status" : "on" }
- Desativação de backup criptografado
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption { "encryption_status" : "off" }
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "encryption_status" : "on" }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.