Enabling or Disabling Encrypted Backup

Function

This API is used to enable or disable encrypted backup. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

POST /v3/{project_id}/instances/{instance_id}/backups/encryption

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Value: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
encryption_status	Yes	String	Whether to enable or disable encrypted backup. Value (case insensitive): on: Enabling encrypted backup off: Disabling encrypted backup
type	No	String	Encryption type. Currently, only kms (case-insensitive) is supported. This parameter is mandatory when encrypted backup is enabled and is not required when encrypted backup is disabled.
kms_key_id	No	String	KMS ID. This parameter is mandatory when encrypted backup is enabled and is not required when encrypted backup is disabled. To obtain the value, see the response parameter key_id in the API for creating a key.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
encryption_status	String	Whether encrypted backup is enabled or disabled. Value: on: Encrypted backup is enabled off: Encrypted backup is disabled.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Enabling encrypted backup

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption
{
  "type" : "kms",
  "kms_key_id" : "b82fa43f-f6e8-4ec4-9c31-231bc547c526",
  "encryption_status" : "on"
}

Disabling encrypted backup

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption
{
  "encryption_status" : "off"
}