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

RDS for MySQL

  • Documentation
    • RDS for MySQLAPI referenceV2（2022-01-01）Backup and recoveryDescribeBinlogFiles
Copy page
Download PDF
Backup and recovery
DescribeBinlogFiles
Copy page
Download PDF
DescribeBinlogFiles

Call the DescribeBinlogFiles API to query Binlog backup files.

Request type

  1. Synchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
mysql-ce48081d****
Instance ID.
StartTime
String
Yes
2022-06-01T15:00:00Z
Query start time. The format is yyyy-MM-ddTHH:mm:ssZ(UTC time).
EndTime
String
Yes
2022-06-20T15:00:00Z
Query end time. The format is yyyy-MM-ddTHH:mm:ssZ(UTC time). The query end time should be later than the query start time, and the time range should not exceed 15 days.
Context
String
No
rds/mysql-603e30e6bd95/mysql-603e30e6bd95-0/binlog/binlog-1683409831637741726-binlog.000041
Index information, used to specify the starting position of the returned backup information. After specifying, the backup information will be returned starting from the next backup file after the one specified by Context.
BackupFileNumber
Integer
No
10
The number of backup files, with a default value of 10 and a maximum value of 250.
ResultSorter
String
No
SortByFileSizeAsc

Support sorting according to specific conditions. Values:

  • Default: Data backups are sorted in descending order by start time by default, and log backups are sorted in descending order by backup time.
  • SortByTimeAsc: Data backups are sorted in ascending order by start time, and log backups are sorted in ascending order by backup time.
  • SortByTimeDesc: Data backups are sorted in descending order by start time, and log backups are sorted in descending order by backup time.
  • SortByFileSizeAsc: Sort in ascending order by file size.
  • SortByFileSizeDesc: Sort in descending order by file size.

Response parameters

Name
Type
Example
Description
Total
Integer
9
Number of backup files.
Context
String
rds/mysql-603e30e6****/mysql-603e30e6****-0/binlog/binlog-1683547416864283247-binlog.000081
Index information. Returns the last backup file as the index. Can be used as a parameter for the next request to load more data.
BinlogFiles
Object[]
Please refer to the response example.
Backup list.
BackupRegion
String
cn-shanghai
The region where the Binlog backup is located.
BackupStatus
String
Success

Backup status, with possible values:

  • Success: Success.
  • Failed: Failure.
  • Running: In progress.
DownloadStatus
String
NotDownload

Download status. Values:

  • NotDownload: Not downloaded.
  • Success: Downloaded successfully.
  • Failed: Download failed.
  • Running: Downloading.
FileName
String
binlog-168348183442461****-binlog.000061
File name.
FileSize
Long
1024
File size. The unit is Byte.
NodeId
String
mysql-f4091b4a****-mda8b-0
The ID of the node to which the Binlog belongs.
UpdateTime
String
2023-05-06T04:50:29.000Z
Update time. The format is yyyy-MM-ddTHH:mm:ss.sssZ(UTC time).
IsEncrypted
Boolean
true

Whether the data backup is encrypted. Values:

  • true: Encrypted.
  • false: Not encrypted.

Sample request 

POST /?Action=DescribeBinlogFiles&Version=2022-01-01 HTTP/1.1
Accept: application/json
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-603e30e6****",
    "StartTime": "2023-05-05T10:49:59Z",
    "EndTime": "2023-05-17T10:49:59Z",
    "BackupFileNumber": 5
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "202305082058412F29109E3B606793D1F7",
        "Action": "DescribeBinlogFiles",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BinlogFiles": [
            {
                "BackupRegion": "cn-beijing",
                "BackupStatus": "Success",
                "DownloadStatus": "NotDownload",
                "FileName": "binlog-1683269409494461068-binlog.000001",
                "FileSize": 169,
                "NodeId": "mysql-f4091b4a****-mda8b-0",
                "UpdateTime": "2023-05-05T07:13:33.000Z"
            },
            {
                "BackupRegion": "cn-beijing",
                "BackupStatus": "Success",
                "DownloadStatus": "NotDownload",
                "FileName": "binlog-1683269413387493959-binlog.000002",
                "FileSize": 3011622,
                "NodeId": "mysql-f4091b4a****-mda8b-0",
                "UpdateTime": "2023-05-05T07:13:33.000Z"
            },
            {
                "BackupRegion": "cn-beijing",
                "BackupStatus": "Success",
                "DownloadStatus": "NotDownload",
                "FileName": "binlog-1683273026662514347-binlog.000003",
                "FileSize": 1123725,
                "NodeId": "mysql-f4091b4a****-seed3-0",
                "UpdateTime": "2023-05-05T07:50:28.000Z"
            },
            {
                "BackupRegion": "cn-beijing",
                "BackupStatus": "Success",
                "DownloadStatus": "NotDownload",
                "FileName": "binlog-1683276626773091536-binlog.000004",
                "FileSize": 1140025,
                "NodeId": "mysql-f4091b4a****-seed3-0",
                "UpdateTime": "2023-05-05T08:50:29.000Z"
            },
            {
                "BackupRegion": "cn-beijing",
                "BackupStatus": "Success",
                "DownloadStatus": "NotDownload",
                "FileName": "binlog-1683280226892626614-binlog.000005",
                "FileSize": 1140087,
                "NodeId": "mysql-f4091b4a****-mda8b-0",
                "UpdateTime": "2023-05-05T09:50:27.000Z"
            }
        ],
        "Context": "rds/mysql-f4091b4a****/mysql-f4091b4a****-0/binlog/binlog-1683280226892626614-binlog.000005",
        "Total": 5
    }
}

Error codes

For more details, refer to Error codes.

Last updated: 2025.08.15 18:32:44