文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考备份与恢复RestoreToNewInstance
复制全文
下载 pdfRestoreToNewInstance
文档反馈
问问助手调用 RestoreToNewInstance 接口按备份文件或按时间点将实例数据恢复至新实例。
请求类型
异步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
SrcDBInstanceId String 必选 示例值：mongo-replica-3b96fa21****
备份恢复所用源实例的实例 ID。
说明
BackupId String 可选 示例值：b8174a144f22443ca3a1a6bcd49d****
源实例的备份文件 ID，用于按备份文件恢复时指定所用备份。
说明
- BackupId 和 RestoreTime 参数必须选择一个传入。
- 您可以调用 DescribeBackups 接口查询指定实例下所有的备份信息，包括备份 ID。
- 当前仅副本集实例支持按备份集恢复到新实例，分片集群实例不支持。更多关于按备份文件恢复到新实例的信息，请参见按备份文件恢复。
RestoreTime String 可选 示例值：2024-04-10T14:17:20Z
用于指定按时间点恢复时所需要恢复的时间点，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
说明
- BackupId 和 RestoreTime 参数必须选择一个传入。
- 您可以调用 DescribeRecoverableTime 接口查询指定实例所支持的可恢复时间段。
- 建议选择 7 天内的时间点进行恢复，恢复时间点超过 7 天，会影响主备实例的读写性能。更多关于按时间点恢复到新实例的信息，请参见按时间点恢复。
ZoneId String 必选 示例值：cn-beijing-a
新实例所在可用区的 ID。
说明
- 您可以调用 DescribeAvailabilityZones 接口查看当前账号下所有可创建 MongoDB 实例的可用区信息，包括可用区 ID。
- 如果您需要为新建的实例部署多可用区，您可以同时传入三个可用区 ID，多个可用区之间用英文逗号（,）隔开。更多详情，请参见多可用区同城容灾解决方案。
VpcId String 必选 示例值：vpc-rs5811nceqyov0x58x4****
私有网络 ID。
说明
SubnetId String 必选 示例值：subnet-274c1ohtlim0w7fap8sna****
子网 ID。
说明
DBEngine String 可选 示例值：MongoDB
数据库引擎。
说明
无需设置。恢复后新实例的数据库引擎与源实例保持一致，取值固定为 MongoDB。
DBEngineVersion String 可选 示例值：MongoDB_5_0
数据库引擎版本。
说明
无需设置。恢复后新实例的数据库版本与源实例保持一致，例如源实例为 MongoDB 5.0，新实例也必须为 MongoDB 5.0。
InstanceType String 可选 示例值：ReplicaSet
MongoDB 的实例类型。取值范围如下：
- ReplicaSet：副本集。
- ShardedCluster：分片集群。
说明
新实例需和源实例的实例类型保持一致。例如源实例类型为分片集群，新实例也必须为分片集群。
NodeSpec String 必选 示例值：mongo.2c4g
实例的规格码。其中：
- 当源实例类型为副本集（即 InstanceType 取值为 ReplicaSet）时，该参数表示恢复后新副本集实例的计算节点规格。
- 当源实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，该参数表示恢复后新分片集群实例 Shard 节点的规格。
说明
NodeNumber Integer 可选 示例值：3
节点数量，其中：
- 当源实例类型为副本集（即 InstanceType 取值为 ReplicaSet）时，该参数表示恢复后新副本集实例的计算节点数量。
- 当源实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，该参数表示恢复后新分片集群实例中，每个 Shard 分片中的节点数量。
说明
当前每个副本集实例和每个 Shard 分片均仅支持 3 个节点，取值固定为3。
MongosNodeSpec String 可选 示例值：mongo.mongos.2c4g
分片集群中 Mongos 节点的规格码。
说明
- 当实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，该参数必填。
- 您可以调用 DescribeNodeSpecs接口查看分片集群的实例规格信息，包括规格码。
MongosNodeNumber Integer 可选 示例值：2
分片集群中 Mongos 节点的数量。取值范围：2~32。
说明
当实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，该参数必填。
ShardNumber Integer 可选 示例值：2
分片集群中 Shard 分片的数量。取值范围：2~32。
说明
当实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，该参数必填。
StorageSpaceGB Integer 必选 示例值：100
副本集实例的总存储空间，或分片集群中单个 Shard 分片的存储空间，单位：GiB，步长为 10。
说明
- 若实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，创建成功后整个实例的总容量为单个 Shard 分片的存储空间乘以 Shard 分片数。
- 您可以调用 DescribeNodeSpecs 接口查看 MongoDB 实例的规格信息，包括不同节点支持的存储空间规格。
ConfigServerNodeSpec String 可选 示例值：mongo.config.2c4g
分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.2c4g。
说明
- 仅当实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，该参数生效。
- 您可以调用 DescribeNodeSpecs接口查看分片集群的实例规格信息，包括规格码。
ConfigServerStorageSpaceGB Integer 可选 示例值：200
分片集群中 ConfigServer 的存储空间，单位：GiB。步长为 10，默认值：20。
说明
- 仅当实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，该参数生效。
- 节点规格不同，对应支持的存储空间上限也不同，您可以调用 DescribeNodeSpecs 接口查看 MongoDB 实例的规格信息，包括不同节点支持的存储空间规格。
SuperAccountName String 可选 示例值：root
数据库账号名称。当前仅支持在创建实例时设置超级管理员账号，账号名称固定为 root。
SuperAccountPassword String 可选 示例值：Password123
root 账号的密码。密码需同时满足如下条件：
- 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。
- 特殊字符包括 !@#$%^&*()_+-=。
- 长度为 8~32 个字符。
- 不允许使用极易被破解的弱密码（如 Admin@123）。
说明
- 若该参数留空，表示不为 root 账号设置密码，此时系统会自动为 root 账号生成一个密码来保证实例访问安全性。
- 您也可以在实例创建后，通过 ResetDBAccount 接口来修改 root 账号的密码。
- 若您在密码中使用了特殊字符，在连接实例时可能需要对特殊字符进行转义。更多详情，请参见需要转义的特殊字符。
- 关于 MongoDB 中禁止使用的弱密码详情，请参见弱密码列表。
InstanceName String 可选 示例值：testname
实例名称。名称需同时满足如下要求：
- 不能以数字、中划线（-）开头。
- 只能包含中文、字母、数字、下划线（_）和中划线（-）。
- 长度需为 2~64 个字符。
说明
- 若该参数不填，实例 ID 默认作为实例名称。
- 您可以根据需要自定义实例名称，实例名称无唯一性要求。
ChargeType String 可选 示例值：Prepaid
实例计费类型，取值范围如下：
- PostPaid（默认）：按量计费（也称后付费）。
- Prepaid：包年包月（也称预付费）。
说明
AutoRenew Boolean 可选 示例值：true
是否开启自动续费，取值范围如下：
- false（默认）：不开启自动续费。
- true：开启自动续费。
说明
当 ChargeType 取值为 Prepaid时，该参数必填。
PeriodUnit String 可选 示例值：Year
指定包年包月实例为包年或者包月类型。取值如下：
- Year：包年。
- Month：包月。
说明
当 ChargeType 取值为 Prepaid时，该参数必填。
Period Integer 可选 示例值：3
包年包月实例的购买时长，其中：
- 当 PeriodUnit 为 Year 时，Period 取值为 1~3。
- 当 PeriodUnit 为 Month 时，Period 取值为 1~9。
说明
当 ChargeType 取值为 Prepaid时，该参数必填。
ProjectName String 可选 示例值：default
选择实例所属的项目。若该参数留空，新建实例会默认加入 default 项目。
说明
Tags Object[] 可选 示例值：
需要绑定的标签键和标签值数组对象。
说明
该参数留空表示新建实例不绑定任何标签。
Key String 必选 示例值：instancetype
需要绑定标签所对应的标签键。
说明
- 当需要为实例绑定标签时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示对应标签键的标签值为空。
- 支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。
- 单个实例最多可绑定 50 个标签。标签键需满足设置规则，具体规则请参见标签设置规则。
Value String 可选 示例值：replica
需要绑定标签所对应的标签值。
说明
- 当需要为实例绑定标签时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示对应标签键的标签值为空。
- 支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。最多同时传入 20 组标签键值对。
- 单个实例最多可绑定 50 个标签。标签键需满足设置规则，具体规则请参见标签设置规则。
NodeAvailabilityZone Object[] 可选 示例值：-
添加只读节点信息，包括只读节点所在的可用区和数量。
说明
该参数留空表示不在实例中添加任何只读节点。
ZoneId String 必选 示例值：cn-beijing-a
只读节点所在的可用区。
说明
只读节点所在的可用区必须为实例所在可用区的子集。
NodeNumber Integer 必选 示例值：1
当前可用区中需要添加的只读节点数量。
当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中：
- 当实例类型为副本集（即 InstanceType 取值为 ReplicaSet）时，该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。
- 当实例类型为分片集群（即 InstanceType 取值为 ShardedCluster）时，该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
说明
Port String 可选 示例值：3717
为恢复后的新实例设置私网连接地址的端口号，取值范围：1000~65535。
说明
- 实例创建成功后，您还可以通过 ModifyDBEndpointPort 接口修改连接地址的端口号。关于修改端口号的更多详情，请参见修改端口号。
返回参数
InstanceId String 示例值：mongo-replica-e405f8e2****
实例 ID。
OrderNO String 示例值：Order707662635934417****
订单 ID。
示例
请求示例 1
通过指定备份文件将源副本集实例的数据恢复至新的副本集实例中。
返回示例 1
请求示例 2
将源分片集群中指定时间点的备份数据恢复到新的分片集群实例中。
返回示例 2
错误码
最近更新时间：2026.06.17 18:03:19
这个页面对您有帮助吗？
有用
有用
无用
无用