DescribeBackups--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeBackups

最近更新时间：2025.01.22 12:04:44首次发布时间：2023.02.02 17:41:21

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

请求类型

同步请求。

调试

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`：逻辑备份。说明无默认值。不传该字段时返回其他字段所限定的查询条件下所有状态的备份。
PageNumber	Integer	否	1	当前页页码。取值最小为 1。默认值为 1。
PageSize	Integer	否	10	每页记录数。最小值为 1，最大值不超过 100。默认值为 10。
Option	Object	否	请参见请求示例。	查询的扩展配置。
ProjectName	String	否	default	项目名称。用于在不指定实例 ID 时，查询指定项目下的已删除实例的备份。

返回参数

参数	类型	示例值	描述
Total	Integer	1	备份总数。
Backups	Object[]	无	备份列表。

示例

请求示例

POST /?Action=DescribeBackups&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.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",
                "BackupRegion": "cn-shanghai",
                "BackupStartTime": "2024-07-08T04:34:01.000Z",
                "BackupStatus": "Success",
                "BackupType": "Full",
                "CanDelete": true,
                "ConsistentTime": "",
                "CreateType": "System",
                "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
    }
}

错误码

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