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

RDS for MySQL

Copy page
Download PDF
Backup and recovery
DescribeBackupEncryptionStatus - Query the backup encryption policy of an instance
Copy page
Download PDF
DescribeBackupEncryptionStatus - Query the backup encryption policy of an instance
Call the DescribeBackupEncryptionStatus API to query the backup encryption policy of an instance.​
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.​
  • 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.​
​
Response parameters​
​
Parameter​
Type​
Sample value​
Description​
DataEncryptionStatus​
String​
On​
Indicates whether encryption is enabled for data backup. Values:​
  • On: enabled.​
  • Off: disabled.​
LogEncryptionStatus​
String​
On​
Specifies whether to enable encryption for log backup. Values:​
  • On: enabled.​
  • Off: disabled.​
​
Sample​
Sample request​
​
POST /?Action=DescribeBackupEncryptionStatus&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****"​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "2024051511492825FD41C99A9BDE8B9D7F-1b2940",​
"Action": "DescribeBackupEncryptionStatus",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"DataEncryptionStatus": "Off",​
"LogEncryptionStatus": "On"​
}​
}​
​
Error code​
For more details, refer to Error codes.​
Last updated: 2026.05.28 15:17:54