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

RDS for MySQL

Copy page
Download PDF
Backup and recovery
DescribeBackupDecryptionKey - Query the encryption key for a backup
Copy page
Download PDF
DescribeBackupDecryptionKey - Query the encryption key for a backup
Call the DescribeBackupDecryptionKey API to query the encryption key for a backup.​
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.​
BackupId​
String​
Yes​
  • BackupId example: f1f2284117a344a38370c37b841fec75​
  • FileName example: binlog-1683420632178737071-binlog.000044​
Data backup ID or the file name of the log backup.​
If you are querying the key for data backup encryption, the value of this field is the BackupId of the backup file, which you can obtain by calling the DescribeBackups API. If you are querying the key for log backup encryption, the value of this field is the FileName of the backup file, which you can obtain by calling the DescribeBinlogFiles API.​
​
Response parameters​
​
Parameter​
Type​
Sample value​
Description​
DecryptionKey​
String​
889a48446dece6e4a9c8033ade4e5903​
Key.​
Iv​
String​
ec81a486bada45c0​
Initialization vector.​
tip​
This field is returned only when querying the key for a log backup.​
​
Sample​
Sample request​
​
POST /?Action=DescribeBackupDecryptionKey&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****",​
"BackupId": "binlog_mysql-0d458bb5****-mb27f-0_1715747255925159171-binlog.000020"​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "2024051513250710A7B3BCF7ECB986A033-e2f1e9",​
"Action": "DescribeBackupDecryptionKey",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {​
"DecryptionKey": "aa7e7d668764ae9abf420a7de01004ad",​
"Iv": "ec81a486bada45c0"​
}​
}​
​
Error code​
For more details, refer to Error codes.​
Last updated: 2026.05.28 15:17:54