文档中心

云数据库 MySQL 版

备份与恢复

DescribeBackups - 查询数据备份列表

调用 DescribeBackups 接口查询数据备份列表。

请求类型

同步请求。

注意事项

MySQL 8.4 版本的实例不支持备份加密功能和跨地域备份功能。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	否	mysql-603e30e6****	实例 ID。说明查询已删除实例备份时，即 ResultFilter 字段取值为 DeletedInstanceBackupOnly 时，可不传该字段。其他查询场景下该字段为必选。
BackupId	String	否	06797d5eff774e339d6cbbefa2aa****	备份 ID。说明无默认值。不传该字段时返回其他字段所限定的查询条件下所有备份。
BackupStartTime	String	否	2022-01-01T10:10:10.000Z	备份创建最早时间。接受如下格式的 UTC 时间： 2022-01-02T15:04:05Z 会转换成 2022-01-02 15:04:05 格式的本地时间。如果传入的不是指定 UTC 格式的时间则原样返回。
BackupEndTime	String	否	2022-01-01T20:10:10.000Z	备份创建最晚时间。接受如下格式的 UTC 时间： 2022-01-02T15:04:05Z 会转换成 2022-01-02 15:04:05 格式的本地时间。如果传入的不是指定 UTC 格式的时间则原样返回。
BackupStatus	String	否	Success	备份状态，取值： Success：成功。 Failed：失败。 Running：执行中。说明无默认值。不传该字段时返回其他字段所限定的查询条件下所有状态的备份。
BackupType	String	否	Full	备份方式，取值： Full：物理备份类型下的全量备份或逻辑备份类型下的库表备。 Increment：物理备份类型下的增量备份。 DumpAll：逻辑备份类型下的全库备份。说明无默认值。不传该字段时返回其他字段所限定的查询条件下所有方式的备份。
CreateType	String	否	System	备份的创建者。取值： System：系统。 User：用户。说明无默认值。不传该字段时返回其他字段所限定的查询条件下所有类型的备份。
BackupMethod	String	否	Physical	备份类型，取值： Physical：物理备份。 Logical：逻辑备份。 Snapshot：快照备份。说明无默认值。不传该字段时返回其他字段所限定的查询条件下所有状态的备份。
PageNumber	Integer	否	1	当前页页码。取值最小为 1。默认值为 1。
PageSize	Integer	否	10	每页记录数。最小值为 1，最大值不超过 1000。默认值为 10。
Option	Object of BackupExtraOption	否	请参见请求示例。	查询的扩展配置。
ProjectName	String	否	default	项目名称。用于在不指定实例 ID 时，查询指定项目下的已删除实例的备份。
BackupName	String	否	手动备份001	备份的名称。若您未设置备份名称，此处将返回备份 ID。

BackupExtraOption

参数	类型	是否必选	示例值	描述
ResultFilter	String	否	CrossRegionOnly	查询条件。取值： Default：查询基础备份和跨地域备份。 BasicBackupOnly：仅查询基础备份。 CrossRegionOnly：仅查询跨地域备份。 DeletedInstanceBackupOnly：仅查询已删除实例的备份。说明取值为 DeletedInstanceBackupOnly 时：可不传 InstanceId 字段。可传入 ProjectName 字段，按项目查询已删除实例的备份。
BriefResultOnly	Boolean	否	true	是否只返回摘要信息。取值： true：是。 false：否。默认值。说明取值为 true 时，将不返回 DBTableInfos 字段。
ResultSorter	String	否	SortByFileSizeAsc	支持按照特定条件排序。取值： Default：数据备份默认按照开始时间降序排序，日志备份默认按照备份时间降序排序排序。 SortByTimeAsc：数据备份按照开始时间升序排序，日志备份按照备份时间开序排序。 SortByTimeDesc：数据备份按照开始时间降序排序，日志备份按照备份时间降序排序。 SortByFileSizeAsc：按照文件大小升序排序。 SortByFileSizeDesc：按照文件大小降序排序。

返回参数

参数	类型	示例值	描述
Total	Integer	1	备份总数。
Backups	Array of BackupObject	无	备份列表。

BackupObject

参数	类型	示例值	描述
BackupEndTime	String	2023-12-26T06:24:45.000Z	备份的结束时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
BackupFileName	String	full-1638021415869047766-163802160043687****.xbstream	备份文件名。
BackupFileSize	Long	1024	备份文件大小，单位为 Byte。
BackupId	String	06797d5eff774e339d6cbbefa2aa****	备份 ID。
BackupMethod	String	Physical	备份类型，取值： Physical：物理备份。 Logical：逻辑备份。 Snapshot：快照备份。
BackupName	String	手动备份001	备份的名称。
BackupRegion	String	cn-shanghai	备份所在的地域。
BackupStartTime	String	2023-12-26T06:24:43.000Z	备份的开始时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
BackupStatus	String	Success	备份状态，取值： Success：成功。 Failed：失败。 Running：执行中。
BackupType	String	Full	备份方式，取值： Full：物理备份类型下的全量备份或逻辑备份类型下的库表备份。 Increment：物理备份类型下的增量备份（由系统创建）。 DumpAll：逻辑备份类型下的全库备份。说明无默认值。不传该字段时返回其他字段所限定的查询条件下所有类型的备份。
ConsistentTime	String	2022-01-01T10:10:10Z	一致性快照的时间点，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
CreateType	String	System	备份的创建者。取值： System：系统。 User：用户。
DBEngineVersion	String	MySQL_8_0	兼容版本。取值： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。 MySQL 8.4：MySQL 8.4 版本。
DBTableInfos	Array of DBTableInfoObject	[{ "Database": "database1", "Tables": [ "table1" ] }]	备份集中包含的数据库表信息，最多可包括 1 万张表。说明当数据库为空时，不返回该字段。当 BriefResultOnly 取值为 true 时，不返回该字段。
DownloadStatus	String	NotDownload	下载状态。取值： NotDownload：未下载。 Success：已下载。 Failed：下载失败。 Running：下载中。
ExpiredTime	String	2024-01-02T06:24:45.000Z	备份的过期时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
IsEncrypted	Boolean	true	数据备份是否被加密。取值： true：已加密。 false：未加密。
IsExpired	Boolean	false	备份是否过期。取值： true：已过期。 false：未过期。
ErrorMessage	String	-	备份失败的错误信息。说明该字段仅在备份失败时返回。
EngineType	String	RocksDB	数据库引擎类型。取值： InnoDB：InnoDB 引擎。 RocksDB：RocksDB 引擎。说明作为请求参数时，默认值为 InnoDB。

DBTableInfoObject

参数	类型	示例值	描述
Database	String	db1	数据库名称。
Tables	Array of String	["table1","table2","table3"]	数据表名称。

示例

请求示例

POST /?Action=DescribeBackups&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-ce48081d****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20240708123429B0632E8A17E7206934CE-44fd0d",​
        "Action": "DescribeBackups",​
        "Version": "2022-01-01",​
        "Service": "rds_mysql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Backups": [​
            {​
                "BackupEndTime": "2024-07-08T04:34:09.000Z",​
                "BackupFileName": "full-1720413240726014861.xbstream",​
                "BackupFileSize": 183100084,​
                "BackupId": "c3331a5996ca4103b98376a153fadb14",​
                "BackupMethod": "Physical",​
                "BackupName": "手动备份001",​
                "BackupRegion": "cn-shanghai",​
                "BackupStartTime": "2024-07-08T04:34:01.000Z",​
                "BackupStatus": "Success",​
                "BackupType": "Full",​
                "CanDelete": true,​
                "ConsistentTime": "",​
                "CreateType": "System",​
                "DBEngineVersion": "MySQL_5_7",​
                "DBTableInfos": [​
                    {​
                        "Database": "testdb1",​
                        "Tables": [​
                            ""​
                        ]​
                    },​
                    {​
                        "Database": "testdb2",​
                        "Tables": [​
                            ""​
                        ]​
                    },​
                    {​
                        "Database": "testdb3",​
                        "Tables": [​
                            "t3",​
                            "t2",​
                            "t1"​
                        ]​
                    }​
                ],​
                "DownloadStatus": "NotDownload",​
                "ExpiredTime": "2024-07-15T04:34:09.000Z",​
                "IsEncrypted": false,​
                "IsExpired": false​
            },​
            {​
                "BackupEndTime": "2024-07-08T04:34:03.000Z",​
                "BackupFileName": "full-1720413240726014861.xbstream",​
                "BackupFileSize": 183100084,​
                "BackupId": "18a414f362a74349a63de3fb2df113c5",​
                "BackupMethod": "Physical",​
                "BackupRegion": "cn-beijing",​
                "BackupStartTime": "2024-07-08T04:34:01.000Z",​
                "BackupStatus": "Success",​
                "BackupType": "Full",​
                "CanDelete": true,​
                "ConsistentTime": "",​
                "CreateType": "User",​
                "DBTableInfos": [​
                    {​
                        "Database": "testdb1",​
                        "Tables": [​
                            ""​
                        ]​
                    },​
                    {​
                        "Database": "testdb2",​
                        "Tables": [​
                            ""​
                        ]​
                    },​
                    {​
                        "Database": "testdb3",​
                        "Tables": [​
                            "t3",​
                            "t2",​
                            "t1"​
                        ]​
                    }​
                ],​
                "DownloadStatus": "Success",​
                "ExpiredTime": "2024-07-15T04:34:03.000Z",​
                "IsEncrypted": false,​
                "IsExpired": false​
            }​
        ],​
        "Total": 2​
    }​
}​

错误码

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

最近更新时间：2026.06.10 10:58:16

这个页面对您有帮助吗？

有用

无用