接口说明
适用引擎
- 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**** |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| RequestId | string |
请求ID。 |
AD67C22F-64F3-4448-A9A8-D1606D242879 |
| Records | object [] |
用户备份文件详情列表。 |
|
| Status | string |
用户备份文件状态。返回值：
|
BackupSuccess |
| CreationTime | string |
用户备份的导入开始时间，格式为Unix时间戳。单位：毫秒。 |
1623231084000 |
| FinishTime | string |
用户备份成功导入的时间，格式为Unix时间戳。单位：毫秒。 |
1623231750000 |
| Comment | string |
用户备份的备注信息。 |
BackupTest |
| OssFilePath | string |
OSS中用户备份文件的路径。 |
test/backup_qp.xb |
| OssBucket | string |
用户备份文件所在的OSS Bucket名称。 |
BackupTest |
| ModificationTime | string |
用户备份的导入完成时间，格式为Unix时间戳。单位：毫秒。 |
1623231750000 |
| OssFileSize | long |
OSS中用户备份文件的大小。单位：KB。 |
79115 |
| OssFileName | string |
OSS中用户备份文件的文件名。 |
backup_qp.xb |
| EngineVersion | string |
数据库版本。 |
5.7 |
| BackupId | string |
用户备份ID。 |
b-kwwvr7v8t7of**** |
| RestoreSize | string |
还原用户备份所需存储空间大小。单位：GB。 |
20 |
| ZoneId | string |
用户备份所在的可用区ID。 |
cn-hangzhou-b |
| Retention | integer |
用户备份文件保留时长。单位：天。 |
3 |
| Engine | string |
数据库引擎。 |
mysql |
| OssUrl | string |
用户备份文件的OSS下载地址。 |
https://****.oss-ap-****.aliyuncs.com/backup_qp.xb |
| OssFileMetaData | string |
用户备份文件元信息。更多信息，请参见管理文件元信息。 |
{\”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 | string |
备份文件中的Binlog文件信息，备份过程中如有增量内容则会返回此参数。 |
{\”binlogPosition\”:\”154\”,\”binlogFile\”:\”0.000002\”} |
| Reason | string |
用户备份文件导入失败的原因。 |
success |
示例
正常返回示例
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 描述信息更新 | 看变更集 | ||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/156565.html