Activación o desactivación de la copia de respaldo encriptada
Función
Esta API se utiliza para habilitar o deshabilitar la copia de respaldo encriptada. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
POST /v3/{project_id}/instances/{instance_id}/backups/encryption
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
instance_id |
Sí |
String |
ID de instancia, que es compatible con el formato UUID. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
X-Language |
No |
String |
Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
encryption_status |
Sí |
String |
Si se debe habilitar o deshabilitar la copia de respaldo encriptada. Valor (sin distinción entre mayúsculas y minúsculas):
|
type |
No |
String |
Tipo de encriptación. Actualmente, solo se admite kms (sin distinción entre mayúsculas y minúsculas). Este parámetro es obligatorio cuando la copia de respaldo encriptado está habilitado y no es necesario cuando la copia de respaldo encriptado está deshabilitado. |
kms_key_id |
No |
String |
ID de KMS. Este parámetro es obligatorio cuando la copia de respaldo encriptado está habilitado y no es necesario cuando la copia de respaldo encriptado está deshabilitado. Para obtener el valor, véase el parámetro de respuesta key_id en la API para la creación de una clave. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
encryption_status |
String |
Si la copia de respaldo encriptada está habilitada o deshabilitada. Valores:
|
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Ejemplo de la solicitud
- Habilitación de copia de respaldo encriptada
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption { "type" : "kms", "kms_key_id" : "b82fa43f-f6e8-4ec4-9c31-231bc547c526", "encryption_status" : "on" }
- Desactivación de copia de respaldo encriptada
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption { "encryption_status" : "off" }
Ejemplo de la respuesta
Código de estado: 200
Operación exitosa.
{ "encryption_status" : "on" }
Código de estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.