该接口用于查询所有已导入至RDS的用户备份的详情。
接口说明
适用引擎
- RDS MySQL
功能说明
- 用户备份即MySQL自建库的全量备份数据，您可以将用户备份恢复至云上。更多信息，请参见自建MySQL 5.7数据库全量上云。
- 通过CreateDBInstance接口创建RDS MySQL备份上云实例时，可调用此接口查询用户备份ID。
- 您可以调用ImportUserBackupFile接口将用户备份导入RDS。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Status | string | 否 | 通过用户备份文件的状态查询目标用户备份。取值：
| CheckSuccess |
| RegionId | string | 是 | 地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
| Comment | string | 否 | 通过备注信息查询目标用户备份。 说明
您可输入目标用户备份的部分备注信息进行模糊匹配。
| BackupTest |
| BackupId | string | 否 | 通过用户备份ID查询目标用户备份。 | b-kwwvr7v8t7of**** |
| OssUrl | string | 否 | 通过用户备份文件的OSS下载地址查询目标用户备份。如何获取用户备份文件的OSS下载地址，请参见上传Object后如何获取访问URL。 | https://****.oss-ap-****.aliyuncs.com/backup_qp.xb |
| Tags | string | 否 | 通过标签信息查询目标用户备份。 | key1:value1 |
| ResourceGroupId | string | 否 | 资源组ID。可调用DescribeDBInstanceAttribute获取。 | rg-acfmy**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "AD67C22F-64F3-4448-A9A8-D1606D242879",
"Records": [
{
"Status": "BackupSuccess",
"CreationTime": "1623231084000",
"FinishTime": "1623231750000",
"Comment": "BackupTest",
"OssFilePath": "test/backup_qp.xb",
"OssBucket": "BackupTest",
"ModificationTime": "1623231750000",
"OssFileSize": 79115,
"OssFileName": "backup_qp.xb",
"EngineVersion": "5.7",
"BackupId": "b-kwwvr7v8t7of****",
"RestoreSize": "20",
"ZoneId": "cn-hangzhou-b",
"Retention": 3,
"Engine": "mysql",
"OssUrl": "https://****.oss-ap-****.aliyuncs.com/backup_qp.xb",
"OssFileMetaData": "{\\\"Accept-Ranges\\\":\\\"bytes\\\",\\\"Connection\\\":\\\"keep-alive\\\",\\\"Content-Length\\\":81014337,\\\"Content-Type\\\":\\\"application/octet-stream\\\",\\\"Date\\\":1623309548000,\\\"ETag\\\":\\\"889FE9E5FCEBFE4781829488A352863B-1\\\",\\\"Last-Modified\\\":1622186844000,\\\"Server\\\":\\\"AliyunOSS\\\",\\\"x-oss-hash-crc64ecma\\\":\\\"5793608435727323129\\\",\\\"x-oss-object-type\\\":\\\"Multipart\\\",\\\"x-oss-request-id\\\":\\\"60C1BCEC92572F37318BD499\\\",\\\"x-oss-server-time\\\":\\\"166\\\",\\\"x-oss-storage-class\\\":\\\"Standard\\\"}",
"BinlogInfo": "{\\\"binlogPosition\\\":\\\"154\\\",\\\"binlogFile\\\":\\\"0.000002\\\"}",
"Reason": "success"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2023-07-25 | OpenAPI 入参发生变更 | 看变更集 | ||||
| ||||||
| 2022-06-23 | OpenAPI 描述信息更新 | 看变更集 | ||||
|
