调用 DescribeBackups 接口查询数据备份列表。
同步请求。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
InstanceId | String | 否 | mysql-603e30e6**** | 实例 ID。 |
BackupId | String | 否 | 06797d5eff774e339d6cbbefa2aa**** | 备份 ID。 说明 无默认值。不传该字段时返回其他字段所限定的查询条件下所有备份。 |
BackupStartTime | String | 否 | 2022-01-01T10:10:10.000Z | 备份创建最早时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。 |
BackupEndTime | String | 否 | 2022-01-01T20:10:10.000Z | 备份创建最晚时间，格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。 |
BackupStatus | String | 否 | Success | 备份状态，取值：
说明 无默认值。不传该字段时返回其他字段所限定的查询条件下所有状态的备份。 |
BackupType | String | 否 | Full | 备份方式，取值：
说明 无默认值。不传该字段时返回其他字段所限定的查询条件下所有方式的备份。 |
CreateType | String | 否 | System | 备份的创建者。取值：
说明 无默认值。不传该字段时返回其他字段所限定的查询条件下所有类型的备份。 |
BackupMethod | String | 否 | Physical | 备份类型，取值：
说明 无默认值。不传该字段时返回其他字段所限定的查询条件下所有状态的备份。 |
PageNumber | Integer | 否 | 1 | 当前页页码。取值最小为 1。默认值为 1。 |
PageSize | Integer | 否 | 10 | 每页记录数。最小值为 1，最大值不超过 100。默认值为 10。 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
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 }, { "BackupEndTime": "2024-07-08T04:32:47.000Z", "BackupFileName": "logical-1720413167756704752", "BackupFileSize": 3181590, "BackupId": "16554a0c919348fc84fe776f8939c3b5", "BackupMethod": "Logical", "BackupRegion": "cn-beijing", "BackupStartTime": "2024-07-08T04:32:48.000Z", "BackupStatus": "Success", "BackupType": "Full", "CanDelete": true, "ConsistentTime": "", "CreateType": "User", "DBTableInfos": [ { "Database": "testdb3", "Tables": [ "t1", "t2" ] } ], "DownloadStatus": "NotDownload", "ExpiredTime": "2024-07-15T04:32:47.000Z", "IsEncrypted": false, "IsExpired": false }, { "BackupEndTime": "2024-07-08T04:28:49.000Z", "BackupFileName": "logical-1720412929446797149", "BackupFileSize": 3182551, "BackupId": "30403ae346d54538844b374d89fabc76", "BackupMethod": "Logical", "BackupRegion": "cn-beijing", "BackupStartTime": "2024-07-08T04:28:49.000Z", "BackupStatus": "Success", "BackupType": "DumpAll", "CanDelete": true, "ConsistentTime": "", "CreateType": "User", "DBTableInfos": [ { "Database": "testdb3", "Tables": [ "t1" ] } ], "DownloadStatus": "NotDownload", "ExpiredTime": "2024-07-15T04:28:49.000Z", "IsEncrypted": false, "IsExpired": false }, { "BackupEndTime": "2024-07-08T04:26:32.000Z", "BackupFileName": "full-1720412789599988011.xbstream", "BackupFileSize": 182898151, "BackupId": "c08bf41fe9c242a3af5389910b317f4a", "BackupMethod": "Physical", "BackupRegion": "cn-beijing", "BackupStartTime": "2024-07-08T04:26:30.000Z", "BackupStatus": "Success", "BackupType": "Full", "CanDelete": false, "ConsistentTime": "", "CreateType": "System", "DBTableInfos": [ { "Database": "testdb1", "Tables": [ "" ] }, { "Database": "testdb2", "Tables": [ "" ] }, { "Database": "testdb3", "Tables": [ "t1" ] } ], "DownloadStatus": "Success", "ExpiredTime": "2024-07-15T04:26:32.000Z", "IsEncrypted": false, "IsExpired": false } ], "Total": 5 } }
更多详情，请参见错误码。