调用 RestoreToNewInstance 接口将数据恢复到一个新实例。

请求类型

异步请求。

注意事项

当前不支持将单可用区实例恢复为多可用区实例，或将多可用区实例恢复为单可用区实例。

不支持跨大版本恢复实例。例如：将 MySQL 5.7 版本的实例恢复为 MySQL 8.0 版本的实例。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
SrcInstanceId	String	是	mysql-603e30e6****	备份数据所属的原实例的 ID。
BackupId	String	否	2b18d7e970c442caae05be478a9e****	备份文件 ID。通过调用 DescribeBackups 可查询 BackupID。说明该参数与 RestoreTime 参数二者必选其一。可选择物理备份或逻辑备份的备份集进行恢复。使用逻辑备份进行恢复时，仅支持将备份中所有非系统数据库的表的数据结构和内容恢复到新实例。
RestoreTime	String	否	2022-01-01T10:10:10Z	原实例备份保留周期内的任意时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。通过调用 DescribeRecoverableTime 可查询该时间点是否支持还原。说明该参数与 BackupId 参数二者必选其一。
NodeInfo	Array of NodeInfoObject	是	请参见请求示例。	实例规格配置。主节点和备节点有且只有 1 个，只读节点可选 0~10 个。
StorageType	String	是	LocalSSD	实例的存储类型。取值范围： LocalSSD：本地 SSD 盘。 CloudESSD_FlexPL：FlexPL 云盘。 CloudESSD_PL0：PL0 云盘。 CloudESSD_HighPerf：高性能云盘。说明如需设定 StorageSpace 参数，StorageType 参数为必传。当 InstanceType 取值为 SingleNode 时，StorageType 取值只能为 CloudESSD_FlexPL、CloudESSD_PL0 或 CloudESSD_HighPerf。在不同接口中，该参数取值范围不同。具体规则如下：在以下接口中作为请求参数时，StorageType 的取值只能为 LocalSSD。 RestoreToCrossRegionInstance RestoreToNewInstanceFromUserTos 在部分接口中作为请求参数时，该参数的取值范围与原实例的存储类型有关，具体规则如下：原实例的存储类型为 LocalSSD时，不支持变更存储类型。原实例的存储类型为 CloudESSD_PL0 时，可取值为 CloudESSD_PL0、 CloudESSD_FlexPL 或 CloudESSD_HighPerf。涉及的接口是： RebuildDBInstance RestoreToNewInstance ModifyDBNodeSpec
StorageSpace	Integer	否	100	实例存储空间。取值范围：[原实例存储空间大小, 新实例主节点规格对应可选择存储空间范围的上限]，单位为 GiB，步长为 10 GiB。默认值为原实例空间大小。说明每个规格对应的存储空间取值范围不同，关于存储空间取值范围的详细信息，请参见产品规格。
VpcId	String	是	vpc-2d70di2hrnbpc58ozfdx9****	私有网络（VPC） ID。可调用 DescribeVpcs 查询。说明不支持使用共享 VPC。
SubnetId	String	是	subnet-2d70dj20bob9c58ozfek6****	子网 ID。可调用 DescribeSubnets 通过指定 VpcId 和 ZoneId （主节点或备节点所在的可用区）查询可用的子网。
Port	Integer	否	3306	默认终端的私网端口。端口号的取值范围为 1000~65534，默认值为 3306。创建新的连接终端或开启新地址时，将使用默认终端的私网端口实时配置为默认端口。
AllowListIds	Array of String	否	[ "acl-a29be2559dc4406883d358892b90**", "acl-ded4c0b707e44efd8f0dbc4e88f5**" ]	白名单 ID。如需绑定多个白名单，白名单 ID 用英文逗号（,）分隔。一个实例最多可绑定 100 个白名单。说明通过 RestoreToNewInstance 接口恢复到新实例时默认不会绑定源实例的白名单。如有需要，您可在调用该接口前，通过调用 DescribeAllowLists 查询源实例所绑定的白名单，并将其写入该字段；也可以在恢复到新实例后，通过调用 AssociateAllowList 接口绑定白名单到新实例。
InstanceName	String	否	Name123	实例名称。实例名称的命名规则如下：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。
DBParamGroupId	String	否	mysql-sys-6013c7b8f7ef****	参数模板 ID。默认值为数据库引擎版本对应的默认参数模板。
ProjectName	String	否	Test	所属项目。
ChargeInfo	Object of ChargeInfoObject	是	请参见请求示例。	付费方式。
InstanceTags	Array of TagObject	否	[ { "Key":"key1", "Value":"value1" }, { "Key":"key2", "Value":"value2" } ]	实例标签。每个 MySQL 实例最多可绑定 50 个标签。单次操作中最多可添加 20 个标签。
AutoStorageScalingConfig	Object of AutoStorageScalingConfig	否	请参见请求示例。	自动扩容配置。
DeletionProtection	String	否	Enabled	是否启用实例的删除保护功能。取值： Enabled：是。 Disabled：否。默认值。
TableMeta	Array of TableMeta	否		进行库表恢复时，指定恢复的库表信息。说明仅恢复指定库表数据时，填写该参数。
ProxyNodeCustom	Object of ProxyNodeCustom	否	请参见请求示例。	实例的代理配置。说明当备份所属的原实例为多节点实例时该字段必选。当备份所属的原实例为双节点实例时该字段不生效。
EnableExternalReplication	Boolean	否	false	是否开启原生复制。取值： true：是。 false：否。默认值。说明该配置仅在 InstanceType 取值为 SingleNode 时生效。
PrivateIpAddress	String	否	192.168.xxx.xxx	指定实例的默认终端在指定私有网络和子网下的 IP 地址。说明如不设定，则自动为实例的默认终端分配指定私有网络和子网下的 IP 地址。
AutoUpgradeMinorVersion	String	否	Auto	实例内核小版本的升级策略。取值： Auto：自动升级。当发布新的内核小版本时，实例将在设置的可维护时间段内，自动升级至最新的内核小版本。 Manual：手动升级。当发布新的内核小版本时，您需要在控制台手动至最新的内核小版本。具体操作，请参见手动升级实例内核小版本。说明若实例的内核小版本超出维护周期时，系统会暂时忽略内核小版本的升级策略设定，自动为实例升级内核小版本。

NodeInfoObject

参数	类型	是否必选	示例值	描述
NodeId	String	否	mysql-050b3e08****-r6e25	节点 ID。说明创建实例或新增节点时无需传入，变更节点配置或删除节点时必传。
NodeType	String	是	Primary	节点类型，取值： Primary：主节点。 Secondary：备节点。 ReadOnly：只读节点。说明在查询实例价格详情接口（DescribeDBInstancePriceDetail）中，该字段为可选。在增加节点（CreateDBNodes）时，该字段取值只能为 ReadOnly（双节点实例）或 Secondary（多节点实例）。对于双节点实例，主节点和备节点有且只有 1 个，只读节点可选 0~10 个。对于多节点实例，主节点有且只有 1 个，最多可添加 8 个备节点，最少需有 1 个备节点。建议预留一个不承载业务的独立备节点，以便在必要时将其切换为主节点。若因未设置独立备节点致使所有备节点主备延迟过高，进而导致主节点切换失败，云数据库 MySQL 版不承担相关责任。
NodeSpec	String	是	rds.mysql.1c2g	节点规格。关于节点规格的详细信息，请参见产品规格。说明备节点的规格需与主节点的规格保持一致。只读节点规格可低于主节点的规格。但需注意，当只读节点规格低于主节点规格时，可能会因为主节点负载过高导致只读节点存在延迟甚至只读节点 OOM。建议为只读节点选择采与主节点相同或更高的规格。如 StorageType 取值为 CloudESSD_FlexPL 或 CloudESSD_PL0，NodeSpec 只能传入通用规格。
ZoneId	String	是	cn-beijing-a	节点所在可用区，可调用 DescribeAvailabilityZones 接口查询。在创建实例和新增节点时必传，变更节点配置或删除节点时可不传。说明一个实例的节点最多可分布在三个可用区。在一次变配中，最多可增删三个可用区下的节点。
NodeOperateType	String	否	Modify	操作类型。创建实例时无需传入，修改节点配置时需要传入。取值范围： Create：增加。 Modify：修改。说明在增加节点（CreateDBNodes）时，该字段只能取值为 Create。在变更配置时，该字段只能取值为Modify。填写为 Delete 时，该取值无实际意义。

ChargeInfoObject

参数	类型	是否必选	示例值	描述
ChargeType	String	是	PostPaid	付费类型。取值： PostPaid：按量付费（后付费）。 PrePaid：包年包月（预付费）。
AutoRenew	Boolean	否	true	预付费场景下是否到期自动续费。取值范围： true：到期自动续费。 false：到期不自动续费。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
PeriodUnit	String	否	Month	预付费场景下的购买周期。取值范围： Month：购买周期为月。 Year：购买周期为年。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
Period	Integer	否	1	预付费场景下的购买时长。该参数的取值范围取决于 PeriodUnit 的取值： PeriodUnit 取值为 Month 时，Period 的取值为 1~9。 PeriodUnit 取值为 Year 时，Period 的取值为 1~3。说明 ChargeType 取值为 PrePaid 时，此参数必填。 ChargeType 取值为 PostPaid 时，不需要传入此参数。即使传入参数，系统也会自动忽略，配置不生效。
Number	Integer	否	1	实例购买数量。取值范围为 1~50。默认值为 1。说明在 RestoreToNewInstance 与 RestoreToCrossRegionInstance 接口中，仅支持为该字段取值 1。不支持在批量创建实例时分别为实例指定名称。在批量创建实例时：如在 InstanceName 参数指定了实例名称，则会在指定的实例名称后加序号为批量创建的实例命名。如未在 InstanceName 参数指定实例名称，则会以实例 ID 为实例命名。

TagObject

参数	类型	是否必选	示例值	描述
Key	String	是	tagkey	实例标签的标签键。标签键的设置规则如下：支持任何语言字母或文字（如中文、英文字母等）、数字、空格。支持特殊字符：_.:/=+-@。 volc: 为系统预留的标签键，添加标签时，标签键的开头不能设置为任何大小写形式的 volc:。标签键的长度需为 1~128 个字符。
Value	String	否	tagvalue	实例标签的标签值。标签值的设置规则如下：支持任何语言字母或文字（如中文、英文字母等）、数字、空格。支持特殊字符：_.:/=+-@。标签值的长度需为 0~256 个字符，即标签值可以为空。

AutoStorageScalingConfig

参数	类型	是否必选	示例值	描述
EnableStorageAutoScale	Boolean	是	true	是否开启存储空间的自动扩容功能。取值： true：是。 false：否。说明 StorageConfig 作为请求参数时，如 EnableStorageAutoScale取值为 false，可不传入 StorageThreshold 和 StorageUpperBound 参数。
StorageThreshold	Integer	是	20	触发自动扩容的可用存储空间占比。取值范围为 10~50，默认值为 10，单位为 %。
StorageUpperBound	Integer	是	3000	可自动扩容的存储空间上限。该字段的取值下限为实例存储空间+20 GiB；取值上限为实例主节点规格对应的存储空间取值范围的上限，单位为 GiB。关于不同规格可选择存储空间取值范围的详细信息，请参见产品规格。
ScalingDetectNode	String	否	MasterNode	检测是否需进行自动扩容的节点范围。取值： MasterNode：主节点。 MasterSlaveNodes：主备节点。 AllNodes：所有节点。说明该参数作为请求参数时，默认值为 MasterNode。对于多节点实例，该参数取值为 MasterSlaveNodes 和 AllNodes 的效果相同。对于单节点实例，该参数取值为 MasterNode、MasterSlaveNodes 和 AllNodes 的效果相同。

TableMeta

参数	类型	是否必选	示例值	描述
DBName	String	是	testdb1	指定恢复的数据库。
NewDBName	String	否	testdb2	重命名数据库名称。命名规则如下：名称唯一。长度为 2~64 个字符。以字母开头，以字母或数字结尾。由字母、数字、下划线（_）或中划线（-）组成。不能使用某些预留字，包括 root、admin 等。被禁用的预留字请参见禁用词列表。说明若仅恢复数据表，此参数可以与 DBName 相同。
Table	Array of Table	否	[ { "TableName" : "table1", "NewTableName" : "table2" } ]	指定恢复的表。说明若该值为空，则表明恢复 DBName 参数指定的整个库。

Table

参数	类型	是否必选	示例值	描述
TableName	String	是	table1	指定恢复的表。
NewTableName	String	否	table2	重命名数据表名称。命名规则如下：名称唯一。长度为 2~64 个字符。以字母开头，以字母或数字结尾。由字母、数字、下划线（_）或中划线（-）组成。不能使用某些预留字，包括 root、admin 等。被禁用的预留字请参见禁用词列表。

ProxyNodeCustom

参数	类型	是否必选	示例值	描述
CpuNum	Integer	否	4	实例数据库代理服务的 CPU 核数。取值范围：上限：1024。推荐代理核数为实例所有可服务节点总 CPU 数0.25，结果向上取整。代理核数的取值下限为 2 与主节点 CPU 核数0.125之间的较大值。

返回参数

参数	类型	示例值	描述
InstanceId	String	mysql-e7fda57b****	恢复的新实例的实例 ID。
OrderId	String	Order709899242175681****	订单 ID。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

云数据库 MySQL 版