You need to enable JavaScript to run this app.
导航
RestoreToNewInstance
最近更新时间:2024.07.10 22:19:49首次发布时间:2024.04.26 11:07:55

调用 RestoreToNewInstance 接口按备份文件或按时间点将实例数据恢复至新实例。

请求类型

异步请求。

请求参数

参数
类型
是否必选
示例值
描述
SrcDBInstanceId
String
mongo-replica-3b96fa21****

备份恢复所用源实例的实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。

BackupId
String
b8174a144f22443ca3a1a6bcd49d****

源实例的备份文件 ID,用于按备份文件恢复时指定所用备份。

说明

  • BackupIdRestoreTime 参数必须选择一个传入。
  • 您可以调用 DescribeBackups 接口查询指定实例下所有的备份信息,包括备份 ID。
  • 当前仅副本集实例支持按备份集恢复到新实例,分片集群实例不支持。更多关于按备份文件恢复到新实例的信息,请参见按备份文件恢复
RestoreTime
String
2024-04-10T14:17:20Z

用于指定按时间点恢复时所需要恢复的时间点,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。

说明

  • BackupIdRestoreTime 参数必须选择一个传入。
  • 您可以调用 DescribeRecoverableTime 接口查询指定实例所支持的可恢复时间段。
  • 建议选择 7 天内的时间点进行恢复,恢复时间点超过 7 天,会影响主备实例的读写性能。更多关于按时间点恢复到新实例的信息,请参见按时间点恢复
ZoneId
String
cn-beijing-a

新实例所在可用区的 ID。

说明

  • 您可以调用 DescribeAvailabilityZones 接口查看当前账号下所有可创建 MongoDB 实例的可用区信息,包括可用区 ID。
  • 如果您需要为新建的实例部署多可用区,您可以同时传入三个可用区 ID,多个可用区之间用英文逗号(,)隔开。默认第一个传入的可用区为主可用区,后面传入的两个可用区为备可用区。更多详情,请参见多可用区同城容灾解决方案
DBEngine
String
MongoDB

数据库引擎。

说明

无需设置。恢复后新实例的数据库引擎与源实例保持一致,取值固定为 MongoDB

DBEngineVersion
String
MongoDB_4_0

数据库引擎版本。

说明

无需设置。恢复后新实例的数据库版本与源实例保持一致,例如源实例为 MongoDB 4.0,新实例也必须为 MongoDB 4.0。

NodeSpec
String
mongo.1c2g

实例的规格码。其中:

  • 当源实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示恢复后新副本集实例的计算节点规格。
  • 当源实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示恢复后新分片集群实例 Shard 节点的规格。

说明

您可以调用 DescribeNodeSpecs 接口查看实例规格信息,包括规格码。

NodeNumber
Integer
3

节点数量,其中:

  • 当源实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示恢复后新副本集实例的计算节点数量。
  • 当源实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示恢复后新分片集群实例中,每个 Shard 分片中的节点数量。

说明

当前每个副本集实例和每个 Shard 分片均仅支持 3 个节点,取值固定为3

InstanceType
String
ReplicaSet

MongoDB 的实例类型。取值范围如下:

  • ReplicaSet:副本集。
  • ShardedCluster:分片集群 。

说明

新实例需和源实例的实例类型保持一致。例如源实例类型为分片集群,新实例也必须为分片集群。

MongosNodeSpec
String
mongo.mongos.1c2g

分片集群中 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 实例的规格信息,包括不同节点支持的存储空间规格。
VpcId
String
vpc-rs5811nceqyov0x58x4****

私有网络 ID。

说明

您可以调用 DescribeVpcs 接口查询当前账号下的所有私有网络列表信息,包括私有网络 ID。

SubnetId
String
subnet-274c1ohtlim0w7fap8sna****

子网 ID。

说明

您可以调用 DescribeSubnets 接口查询指定私有网络下的子网列表信息,包括子网 ID。

SuperAccountName
String
root
数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root
SuperAccountPassword
String
Password123

root 账号的密码。密码需同时满足如下条件:

  • 至少包含大写字母、小写字母、数字或特殊字符中的任意三种。
  • 特殊字符包括 !@#$%^&*()_+-=
  • 长度为 8~32 个字符。

说明

  • 若该参数留空,表示不为 root 账号设置密码,此时系统会自动为 root 账号生成一个密码来保证实例访问安全性。
  • 您也可以在实例创建后,通过 ResetDBAccount 接口来修改 root 账号的密码。
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 项目。

说明

项目是一个虚拟的概念,包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理,并且控制项目内用户和角色对这些资源的权限。更多详情,请参见资源管理

NodeAvailabilityZone
Object[]

添加只读节点信息,包括只读节点所在的可用区和数量。

说明

该参数留空表示不在实例中添加任何只读节点。

返回参数

参数
类型
示例值
描述
InstanceId
String
mongo-replica-e405f8e2****
实例 ID。
OrderNO
String
Order707662635934417****
订单 ID。

示例

请求示例 1

通过指定备份文件将源副本集实例的数据恢复至新的副本集实例中。

POST https://mongodb.volcengineapi.com/?Action=RestoreToNewInstance&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "SrcDBInstanceId":"mongo-replica-3b96fa21****",
    "BackupId": "b8174a144f22443ca3a1a6bcd49d****",
    "ZoneId":"cn-beijing-a,cn-beijing-b,cn-beijing-c",
    "NodeSpec":"mongo.4c8g",
    "StorageSpaceGB":30,
    "VpcId": "vpc-13fuw95qz5fk03n6nu45b****",
    "SubnetId": "subnet-mjm6qdbzuio05smt1bwf****",
    "InstanceType":"ReplicaSet"
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "RestoreToNewInstance",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mongo-replica-3b97ba41****",
        "OrderNO": "Order707662635934417****"
    }
}

请求示例 2

将源分片集群中指定时间点的备份数据恢复到新的分片集群实例中。

POST https://mongodb.volcengineapi.com/?Action=RestoreToNewInstance&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "SrcDBInstanceId":"mongo-shard-fc1c77c3****",
    "RestoreTime":"2024-04-10T14:59:00Z",
    "ZoneId":"cn-beijing-a,cn-beijing-b,cn-beijing-c",
    "NodeSpec":"mongo.shard.2c4g",
    "StorageSpaceGB":30,
    "MongosNodeSpec":"mongo.mongos.1c2g",
    "ShardNumber":2,
    "MongosNodeNumber":2,
    "VpcId": "vpc-13fuw95qz5fk03n6nu45b****",
    "SubnetId": "subnet-mjm6qdbzuio05smt1bwf****",
    "InstanceType":"ShardedCluster"
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "202404102304278D6740C041DBE9EB4987-902f0e",
        "Action": "RestoreToNewInstance",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mongo-shard-8bcaa3e1****",
        "OrderNO": "Order735625423621919****"
    }
}

错误码

更多详情,请参见错误码