该接口用于将自建库MySQL 5.7的备份数据导入至RDS。
接口说明
适用引擎
- RDS MySQL
功能说明
用户备份即MySQL自建库的全量备份数据,您可以将用户备份恢复至云上。
注意事项
调用本接口,您需要满足下述条件:
- 已通过XtraBackup备份自建MySQL 5.7,备份文件名以
_qp.xb
结尾。更多信息,请参见自建MySQL 5.7数据库全量上云。 - 已将自建MySQL 5.7的备份文件上传至对应地域的OSS Bucket。更多信息,请参见自建MySQL 5.7数据库全量上云。
说明
本接口当前仅适用于MySQL 5.7。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ImportUserBackupFile | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | RDS地域ID。可调用DescribeRegions获取。 说明
| cn-hangzhou |
EngineVersion | string | 是 | MySQL数据库的版本号。当前仅支持传入5.7。 | 5.7 |
BucketRegion | string | 是 | 自建MySQL 5.7备份文件所在OSS Bucket的地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
BackupFile | string | 是 | 描述OSS Bucket中备份文件信息的JSON数组。示例:
数组中各参数的说明如下:
| {"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"} |
Comment | string | 否 | 要导入的用户备份的备注信息。 | BackupTest |
RestoreSize | integer | 否 | 还原用户备份所需存储空间大小。单位:GB。 说明
| 20 |
Retention | integer | 否 | 用户备份文件保留时长。单位:天。取值为大于0的Integer类型整数。 | 30 |
ZoneId | string | 否 | 可用区ID。可调用DescribeRegions查询。 说明
| cn-hangzhou-b |
ResourceGroupId | string | 否 | 资源组ID。可调用DescribeDBInstanceAttribute获取。 | rg-acfmy**** |
返回参数
示例
正常返回示例
JSON
格式
{
"Status": true,
"RequestId": "A140DD14-DCC9-4548-9C72-52A49A58A310",
"BackupId": "b-n8tpg24c6i0v****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidOssBackupFile.InvalidFile | The specified OSS backup file is invalid. | 操作失败,指定的OSS备份文件无效。 |
400 | OperationDenied.Product | The product code is not supported. | 不支持产品代码。 |
400 | InvalidBackupFile.Format | The specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid. | 指定的参数BackupFile(BackupId、RestoreTime或BackupFile)无效。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-11-21 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-07-25 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-06-23 | OpenAPI 描述信息更新,OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|