You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

Copy page
Download PDF
Backup and recovery
ModifyBackupEncryptionPolicy - Modify backup encryption configuration
Copy page
Download PDF
ModifyBackupEncryptionPolicy - Modify backup encryption configuration
Call the ModifyBackupEncryptionPolicy API to modify backup encryption settings.​
Request type​
Synchronous request.​
Precautions​
  • If you receive the error "The instance version is too low to support the requested operation" when calling this API, submit a ticket to contact technical staff to upgrade the instance.​
  • Cloud disk instances do not support backup encryption currently.​
  • MySQL 8.4 instances do not support backup encryption.​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
​
Parameter​
Type​
Is it required?​
Sample value​
Description​
InstanceId​
String​
Yes​
mysql-0d458bb5****​
Instance ID.​
DataBackupEnabled​
Boolean​
No​
true​
Whether to encrypt the data backup. Values:​
  • true: encrypts data backup.​
  • false: does not encrypt data backup.​
tip​
This parameter has no default value. If omitted, no modification is made.​
LogBackupEnabled​
Boolean​
No​
true​
Specifies whether to encrypt log backups. Values:​
  • true: encrypts log backup.​
  • false: does not encrypt log backup.​
tip​
This parameter has no default value. If omitted, no modification is made.​
​
Response parameter​
null​
Sample​
Sample request​
​
POST /?Action=ModifyBackupEncryptionPolicy&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-0d458bb5****",​
"DataBackupEnabled": false,​
"LogBackupEnabled": true​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "202405151146235EF356A9CB6A5E70EEB4-399688",​
"Action": "ModifyBackupEncryptionPolicy",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
Error code​
For more details, refer to Error codes.​
Last updated: 2026.05.28 15:17:53