接口约束
4.9 备份与恢复
4.9.13 恢复到新实例
"start_time": 1532001446987, "end_time": 1532742139000 }
] }
● 异常响应
请参见异常请求结果。
状态码
● 正常 200
● 异常
请参见状态码。
错误码
请参见错误码。
4.9.13 恢复到新实例
功能介绍
从备份恢复到新实例。
● 调用接口前，您需要了解API 认证鉴权。
调试
您可以在API Explorer中调试该接口。
接口约束
● 源实例和目标实例的数据库类型必须一致，如都是MySQL。
● 源实例和目标实例的数据库版本约束如下：
– MySQL和PostgreSQL的源实例和目标实例的数据库版本必须一致。
– Microsoft SQL Server的源实例和目标实例的数据库版本约束参见表4-186。
● MySQL和PostgreSQL数据库目标实例需大于或等于源实例的数据卷总大小。
URI
● URI格式
POST /v3/{project_id}/instances
● URI样例
https://rds.cn-north-1.myhuaweicloud.com/
v3/0483b6b16e954cb88930a360d2c4e663/instances
● 参数说明
表4-182 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的
project ID。
获取方法请参见获取项 目ID。
请求消息
● 参数说明
表4-183 参数说明
名称 是否
必选
参数类 型
说明
name 是 String 实例名称。
用于表示实例的名称，同一租户下，同 类型的实例名可重名，其中，SQL Server实例名唯一。
取值范围：
支持的字符长度是4~64个字节，必须 以字母或中文开头，区分大小写，可以 包含字母、数字、中文字符（一个中文 字符占用3个字节）、中划线或者下划 线，不能包含其他的特殊字符。
datastore 否 Object 数据库信息，仅适用于SQL Server数据 库，SQL Server跨版本恢复新实例时必 传。
详情请参见表4-185。
恢复新实例的SQL Server版本规则详见 表4-186。
ha 否 Object HA配置参数，创建HA实例时使用。
详情请参见表4-184。
configuration_id 否 String 参数模板ID。
port 否 String 数据库端口信息。
● MySQL数据库端口设置范围为1024
～65535（其中12017和33071被 RDS系统占用不可设置）。
● PostgreSQL数据库端口修改范围为 2100～9500。
● Microsoft SQL Server实例的端口设 置范围为1433和2100~9500（其中 5355和5985不可设置。对于2017 EE、2017 SE、2017 Web版，
5050、5353和5986不可设置）。
当不传该参数时，默认端口如下：
● MySQL默认3306。
● PostgreSQL默认5432。
● Microsoft SQL Server默认1433。
名称 是否 必选
参数类 型
说明
password 是 String 数据库密码。
取值范围：
● SQL Server数据库允许输入~!@#$
%^*-_+?,特殊字符。
● PostgreSQL数据库允许输入~!@#
%^*-_=+?,特殊字符。
建议您输入高强度密码，以提高安全 性，防止出现密码被暴力破解等安全风 险。
backup_strategy 否 Object 高级备份策略。
详情请参见表4-187。
enterprise_projec
t_id 否 String 项目标签。
disk_encryption_i
d 否 String 用于磁盘加密的密钥ID，默认为空。
flavor_ref 是 String 规格码，取值范围：非空,。
详情请参考查询数据库规格的响应消息 中的“spec_code”。
volume 是 Object volume信息。
详情请参见表4-188。
region 否 String 区域ID。 取值参见地区和终端节点。
availability_zone 是 String 可用区ID。对于数据库实例类型不是单 机的实例，需要分别为实例所有节点指 定可用区，并用逗号隔开。详见示例。
取值范围：非空，请参见地区和终端节 点。
vpc_id 否 String 虚拟私有云ID，获取方法如下：
● 方法1：登录虚拟私有云服务的控制
名称 是否 必选
参数类 型
说明
subnet_id 否 String 子网的网络ID信息，获取方法如下：
● 方法1：登录虚拟私有云服务的控制 台界面，单击VPC下的子网，进入 子网详情页面，查找网络ID。
● 方法2：通过虚拟私有云服务的API 接口查询，具体操作可参考查询子 网列表。
data_vip 否 String 指定实例的内网IP，获取方法如下：
● 方法1：登录虚拟私有云服务的控制 台界面，单击VPC下的子网，进入 子网详情页面，查找子网的网段。
● 方法2：通过虚拟私有云服务的API 接口查询，具体操作可参考查询子 网。
security_group_id 否 String 指定实例所属的安全组。
● 方法1：登录虚拟私有云服务的控制 台界面，在安全组的详情页面查找 安全组ID。
● 方法2：通过虚拟私有云服务的API 接口查询，具体操作可参考查询安 全组列表。
restore_point 是 Object 恢复数据源对象。
详情请参见表4-189。
charge_info 否 Object 计费类型信息，支持包年包月和按需，
默认为按需。目前，仅Microsoft SQL Server支持包年包月模式下的恢复到新 实例功能。
详情请参见表4-190。
名称 是否 必选
参数类 型
说明
time_zone 否 String UTC时区。
● 不选择时，各个引擎时区如下：
– MySQL国内站、国际站默认为 UTC时间。
– PostgreSQL国内站、国际站默认 为UTC时间。
– Microsoft SQL Server国内站默 认为China Standard Time，国 际站默认为UTC时间。
● MySQL和PostgreSQL引擎选择填写 时，取值范围为UTC-12:00~UTC +12:00，且只支持整段时间，如 UTC+08:00，不支持UTC+08:30。
● Microsoft SQL Server引擎选择填写 时，请参见表4-28。
dsspool_id 否 String Dec用户专属存储ID，每个az配置的专 属存储不同，Dec用户创建实例时，对 于数据库实例类型不是单机或只读的实 例，需要分别为实例所有节点指定 dsspoolId，并用逗号隔开。 获取方法 如下:
● 方法1：登录专属分布式存储服务 DSS的控制台界面,查看专属存储列 表，选择符合条件的az下的专属dss 的ID。
● 方法2：通过专属分布式存储服务 DSS的API接口查询,具体操作可参考 获取专属存储详情列表。
replica_of_id 否 String 只读实例的主实例ID。创建只读实例时 必选,其它场景不可选。
collation 否 String 仅限Microsoft SQL Server实例创建使 用。对于MySQL和PostgreSQL实例，
该参数无意义。
取值范围：根据查询SQL Server可用 字符集查询可设置的字符集。
名称 是否 必选
参数类 型
说明
tags 否 Array of
objects 标签列表，根据标签键值对创建实例。
● {key}表示标签键，不可以为空或重 复。
● {value}表示标签值，可以为空。
如果创建实例时同时使用多个标签键值 对，中间使用逗号分隔开，最多包含 10组。
详情请参见 表4-191 unchangeable_p
aram 否 Object 不可变更参数列表。该对象中的参数，
在数据库初始化之前指定，指定后不支 持修改。
详情参见表4-192。
dry_run 否 Boolean 是否只预检此次请求，仅支持 MySQL。
● true：发送参数检查请求，不会创 建实例。
– 检查通过：返回202状态码。
– 检查不通过：返回对应错误码，
详情请参考错误码。
● false：发送正常请求，通过检查 后，并且执行创建实例的请求。
count 否 Integer 批量创建实例的数量，取值范围为 1~50。
表4-184 ha 字段数据结构说明
名称 是否必
选
参数类 型
说明
mode 是 String 实例主备模式，取值：Ha，不区分大 小写。
名称 是否必 选
参数类 型
说明
replication_mode 是 String 备机同步参数。
取值：非空。
● MySQL为“async”或
“semisync”。
● PostgreSQL为“async”或
“sync”。
● Microsoft SQL Server为“sync”。
说明
● “async”为异步模式。
● “semisync”为半同步模式。
● “sync”为同步模式。
表4-185 datastore 字段数据结构说明
名称 是
否 必 选
参数类型 说明
type 是 String 数据库引擎，取值如下：
SQLServer version 是 String 数据库版本。
● Microsoft SQL Server：仅支持2017 企业版、2017 标准版、2017 web 版、2014 标准版、2014 企业版、
2016 标准版、2016 企业版、2012 企 业版、2012 标准版、2012 web版、
2008 R2 企业版、2008 R2 标准版、
2008 R2 web版、2014 web版、2016 web版。取值示例2014_SE。
数据库支持的详细版本信息，可调用查询 数据库引擎的版本接口获取。
表4-186 SQL Server 恢复支持的版本规则
原数据库版本 可恢复到的版本
2008 R2 web版 2012 web版 2012 标准版 2012 企业版 2014 web版 2014 标准版 2014 企业版 2016 web版 2016 标准版 2016 企业版 2017 web版 2017 标准版 2017 企业版 2008 R2 企业版 2012 企业版 2014 企业版 2016 企业版 2017 企业版 2008 R2 标准版 2012 标准版 2012 企业版 2014 标准版 2014 企业版 2016 标准版 2016 企业版 2017 标准版 2017 企业版
2012 web版 2012 web版
2012 标准版 2012 企业版 2014 web版 2014 标准版 2014 企业版 2016 web版 2016 标准版 2016 企业版 2017 web版 2017 标准版 2017 企业版
原数据库版本 可恢复到的版本
2012 标准版 2012 标准版
2012 企业版 2014 标准版 2014 企业版 2016 标准版 2016 企业版 2017 标准版 2017 企业版
2012 企业版 2012 企业版
2014 企业版 2016 企业版 2017 企业版
2014 web版 2014 web版
2014 标准版 2014 企业版 2016 web版 2016 标准版 2016 企业版 2017 web版 2017 标准版 2017 企业版
2014 标准版 2014 标准版
2014 企业版 2016 标准版 2016 企业版 2017 标准版 2017 企业版
2014 企业版 2014 企业版
2016 企业版 2017 企业版
2016 web版 2016 web版
2016 标准版 2016 企业版 2017 web版 2017 标准版 2017 企业版
原数据库版本 可恢复到的版本
2016 标准版 2016 标准版
2016 企业版 2017 标准版 2017 企业版
2016 企业版 2016 企业版
2017 企业版
2017 web版 2017 web版
2017 标准版 2017 企业版
2017 标准版 2017 标准版
2017 企业版
2017 企业版 2017 企业版
表4-187 backup_strategy 字段数据结构说明
名称 是否必
选
参数类型 说明
start_time 是 String 备份时间段。自动备份将在该时间段 内触发。
取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时 间。
● HH取值必须比hh大1。
● mm和MM取值必须相同，且取值 必须为00、15、30或45。
取值示例：
● 08:15-09:15
● 23:00-00:00
keep_days 否 Integer 指定备份文件的可保存天数。
取值范围：0～732。该参数缺省，或 取值为0，表示关闭自动备份策略。如 果需要延长保留时间请联系客服人员 申请，自动备份最长可以保留2562 天。
表4-188 volume 字段数据结构说明
名称 是否必
选
参数类型 说明
type 是 String 磁盘类型。
取值范围如下，区分大小写：
● ULTRAHIGH，表示SSD。
● LOCALSSD，表示本地SSD。
● CLOUDSSD，表示SSD云盘。
● ESSD，表示极速型SSD。
size 是 Integer 磁盘大小。
取值范围：40GB~4000GB。必须为 10的整数倍。
须知MySQL和PostgreSQL数据库新实例磁盘
大小必须大于或等于原实例的磁盘大小。
表4-189 restore_point 字段数据结构说明
名称 是否必
选 参数
类型 说明
instance
_id 是 String 实例ID。
type 是 String 表示恢复方式，枚举值：
● “backup”，表示使用备份文件恢复，按照 此方式恢复时，当“type”字段为非必选 时，“backup_id”必选。
● “timestamp”，表示按时间点恢复，按照 此方式恢复时，当“type”字段必选时，
“restore_time”必选。
backup_i
d 否 String 用于恢复的备份ID。当使用备份文件恢复时需要 指定该参数。
须知当“type”字段为非必选时，“backup_id”必选。
restore_t
ime 否 Integ
er 恢复数据的时间点，格式为UNIX时间戳，单位 是毫秒，时区为UTC。
须知当“type”字段必选时，“restore_time”必选。
名称 是否必
_name 否 Map<
String ,String
>
仅适用于SQL Server引擎，当有此参数时表示支 持局部恢复和重命名恢复，恢复数据以局部恢复
– 新数据库名不能包含rdsadmin、master、
msdb、tempdb、model或resource字段
示例："database_name":{"原数据库名称":"新数据库名称"}
正确示例："database_name":
表4-190 charge_info 字段数据结构说明
名称 是
否 必 选
参数类型 说明
charge_mode 是 String 计费模式。
取值范围：
● prePaid：预付费，即包年/包月。
● postPaid：后付费，即按需付费。
period_type 否 String 订购周期类型。
取值范围：
● month：包月。
● year：包年。
说明“charge_mode”为“prePaid”时生
效，且为必选值。
period_num 否 Integer “charge_mode”为“prePaid”时生 效，且为必选值，指定订购的时间。
取值范围：
● 当“period_type”为“month”
时，取值为1~9。
时，取值为1~9。