文档中心

云数据库 MySQL 版

备份与恢复

DescribeBinlogFiles - 查询 Binlog 备份文件

调用 DescribeBinlogFiles 接口查询 Binlog 备份文件。

请求类型

同步请求。

注意事项

若实例未开启 Binlog 日志备份，调用该接口后会返回空值。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-ce48081d****	实例 ID。
StartTime	String	是	2022-06-01T15:00:00Z	查询开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
EndTime	String	是	2022-06-20T15:00:00Z	查询结束时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。查询结束时间应晚于查询开始时间，且时间范围不大于 15 天。
Context	String	否	rds/mysql-603e30xxxx/mysql-603e30xxxx-0/binlog/binlog-16834098316xxxx-binlog.000041	索引信息，用于指定此次返回的备份信息的起始位置。指定后，会从 Context 指定的备份文件的下一个开始返回备份信息。
BackupFileNumber	Integer	否	10	备份文件数量，默认值为 10，最大值为 250。
ResultSorter	String	否	SortByFileSizeAsc	支持按照特定条件排序。取值： Default：数据备份默认按照开始时间降序排序，日志备份默认按照备份时间降序排序排序。 SortByTimeAsc：数据备份按照开始时间升序排序，日志备份按照备份时间开序排序。 SortByTimeDesc：数据备份按照开始时间降序排序，日志备份按照备份时间降序排序。 SortByFileSizeAsc：按照文件大小升序排序。 SortByFileSizeDesc：按照文件大小降序排序。
NodeId	String	否	mysql-f4091b4a****-mda8b-0	Binlog 所属的节点的 ID。说明如指定了节点 ID，则仅返回该节点的 Binlog。

返回参数

参数	类型	示例值	描述
Total	Integer	9	备份文件个数。
Context	String	rds/mysql-603e30e6**/mysql-603e30e6**-0/binlog/binlog-1683547416864283247-binlog.000081	索引信息。以最后一个备份文件作为索引进行返回。可作为下一次请求的参数，加载更多时选择。
BinlogFiles	Array of BinlogFileObject	请参见返回示例。	备份列表。

BinlogFileObject

参数	类型	示例值	描述
BackupRegion	String	cn-shanghai	Binlog 备份所在的 region。
BackupStatus	String	Success	备份状态，取值： Success：成功。 Failed：失败。 Running：执行中。
DownloadStatus	String	NotDownload	下载状态。取值： NotDownload：未下载。 Success：已下载。 Failed：下载失败。 Running：下载中。
FileName	String	binlog-168348183442461****-binlog.000061	文件名。
FileSize	Long	1024	文件大小。单位为 Byte。
NodeId	String	mysql-f4091b4a****-mda8b-0	Binlog 所属的节点的 ID。
UpdateTime	String	2023-05-06T04:50:29.000Z	更新时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
IsEncrypted	Boolean	true	数据备份是否被加密。取值： true：已加密。 false：未加密。

示例

请求示例

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​
}​

返回示例

{​
    "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​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.08.12 10:30:24

这个页面对您有帮助吗？

有用

无用