恢复到新实例
接口说明
根据备份恢复新实例。
约束说明
- 目标实例与源实例的数据库类型必须一致。
- 根据时间点恢复到新实例4.0及以上版本实例支持该功能。
|
名称 |
类型 |
IN |
是否必选 |
描述 |
|---|---|---|---|---|
|
project_id |
string |
path |
是 |
租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。 |
请求参数
|
名称 |
类型 |
IN |
是否必选 |
描述 |
|---|---|---|---|---|
|
X-Auth-Token |
string |
header |
是 |
用户Token。 |
|
名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
name |
String |
是 |
实例名称。 用于表示实例的名称，允许和已有名称重复。 实例名称长度在4个到64个字节之间，必须以字母或中文字开头，区分大小写，可以包含字母、数字、中划线、下划线或中文（一个中文字符占用3个字节），不能包含其他特殊字符。 |
|
availability_zone |
String |
是 |
可用区ID。 取值：非空，请参见地区和终端节点。 |
|
vpc_id |
String |
是 |
虚拟私有云ID。 获取方法请参见《虚拟私有云API参考》中“VPC”的内容。 取值：非空，字符长度校验，严格UUID正则校验。 |
|
subnet_id |
String |
是 |
子网ID。 获取方法请参见《虚拟私有云API参考》中“子网”的内容。 |
|
security_group_id |
String |
是 |
指定实例所属的安全组ID。 获取方法请参见《虚拟私有云API参考》中“安全组”的内容。 |
|
password |
String |
否 |
数据库密码。 取值范围：长度为8~32位，必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?()$的组合。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 |
|
disk_encryption_id |
String |
否 |
磁盘加密时的密钥ID，严格UUID正则校验。 不传该参数时，表示不进行磁盘加密。 |
|
configurations |
Array of objects |
否 |
参数组配置信息。详情请参见表5。 不传该参数时，表示为系统默认参数组。 |
|
flavor |
Array of objects |
是 |
实例规格详情。详情请参见表表6。 获取方法请参见查询所有实例规格信息中参数的值。 |
|
restore_point |
Object |
是 |
恢复到新实例备份信息详情。详情请参见表4。 |
|
backup_strategy |
Object |
否 |
高级备份策略。详情请参见表7。 |
|
enterprise_project_id |
String |
否 |
企业项目ID。
|
|
ssl_option |
String |
否 |
SSL开关选项。 取值：
不传该参数时，默认启用SSL连接。 |
|
charge_info |
Object |
否 |
计费类型信息，支持包年包月和按需计费，默认为按需计费。 详情请参见表8。 |
|
名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
instance_id |
String |
否 |
实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
|
|
type |
String |
否 |
恢复方式，枚举值：
|
|
backup_id |
String |
否 |
用于恢复的备份ID。当使用备份文件恢复时需要指定该参数。
说明：
当“type”字段为非必选时，“backup_id”必选。 |
|
restore_time |
Integer |
否 |
恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。
说明：
当“type”字段必选时，“restore_time”必选。 |
|
参数 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
type |
String |
是 |
节点类型。取值：
枚举值：
|
|
configuration_id |
String |
是 |
参数组id。 |
|
名称 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
type |
String |
是 |
节点类型。 取值：
|
|
num |
String |
是 |
节点数量。 取值：
|
|
size |
String |
否 |
磁盘大小。 取值：必须为10的整数倍。单位为GB。
|
|
spec_code |
String |
是 |
资源规格编码。获取方法请参见查询所有实例规格信息中参数“spec_code”的值。 |
|
参数 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|
|
charge_mode |
String |
是 |
计费模式。 取值范围：
|
|
period_type |
String |
否 |
订购周期类型。 “charge_mode”为“prePaid”时生效，且为必选值。 取值范围：
|
|
period_num |
Integer |
否 |
“charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围：
|
|
is_auto_renew |
Boolean |
否 |
创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 取值范围：
|
|
is_auto_pay |
Boolean |
否 |
创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 取值范围：
|
请求示例中参数“region”和“availability_zone”的值为示例值。
- 请求示例
{ "name": "test-cluster-01", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "restore_point": { "backup_id": "8f643d252d834a4c916b2db4322f99552734" }, "flavor": [ { "type": "mongos", "num": "2", "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "size": "20", "spec_code": "dds.mongodb.c6.medium.4.shard" }, { "type": "config", "num": "1", "size": "20", "spec_code": "dds.mongodb.c6.large.2.config" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "server_group_policies": [ "anti-affinity" ] }副本集根据备份文件恢复到新实例：
"name": "test-replicaset", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "configurations": [ { "type": "replica", "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02" } ], "restore_point": { "backup_id": "8f643d252d834a4c916b2db4322f99552734" }, "flavor": [ { "type": "replica", "num": "1", "storage": "ULTRAHIGH", "size": "30", "spec_code": "dds.mongodb.s2.medium.4.repset" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1" }单节点根据备份文件恢复到新实例：
{ "name": "test-singlenode", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "configurations": [ { "type": "single", "configuration_id": "b8e962e66ede47609a94cba591735b49pr02" } ], "restore_point": { "backup_id": "8f643d252d834a4c916b2db4322f99552734" }, "flavor": [ { "type": "single", "num": "1", "storage": "ULTRAHIGH", "size": "30", "spec_code": "dds.mongodb.c6.medium.4.single" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1" }副本集根据时间点恢复到新实例：
{ "name": "replica-liuyunj1", "availability_zone": "az1xahz", "vpc_id": "dcdadabc-efed-4518-8b34-4af66fcd97e7", "subnet_id": "4a9348f2-f232-4700-a440-2f1641d80960", "security_group_id": "c57b9db2-cccb-4c0d-b058-7ea51dda0c99", "flavor": [ { "type": "replica", "num": 1, "size": 100, "spec_code": "dds.mongodb.c6.large.2.repset" } ], "backup_strategy": { "start_time": "08:00-09:00", "keep_days": "8" }, "restore_point": { "instance_id": "d5833c2854a4486cb7960f829269e211in02", "type": "timestamp", "restore_time": 1607689584000 }, "ssl_option": "1" }
响应参数
- 参数说明
表9 参数说明 名称
参数类型
是否必选
描述
id
String
否
实例ID。
name
String
否
实例名称，与请求参数相同。
datastore
Object
否
数据库信息，与请求参数相同。详情请参见表4。
created
String
否
创建时间为本地时间，格式为“yyyy-mm-dd hh:mm:ss”。
status
String
否
实例状态，取值为“creating”。
region
String
否
区域ID，与请求参数相同。
availability_zone
String
否
可用区ID，与请求参数相同。
vpc_id
String
否
虚拟私有云ID，与请求参数相同。
subnet_id
String
否
子网ID，与请求参数相同。
security_group_id
String
否
实例所属的安全组ID，与请求参数相同。
disk_encryption_id
String
否
磁盘加密的密钥ID，与请求参数相同。
mode
String
否
实例类型，与请求参数相同。
configurations
Array of objects
否
参数组配置信息。
详情请参见表10。
flavor
Array of objects
否
实例规格详情，与请求参数相同。详情请参见表6。
backup_strategy
Object
否
高级备份策略，与请求参数相同。详情请参见表7。
enterprise_project_id
String
否
企业项目ID。取值为“0”，表示为default企业项目。
job_id
String
否
创建实例的工作流ID。
ssl_option
String
否
SSL开关选项，与请求参数相同。
order_id
String
否
创建实例的订单ID，仅创建包年包月实例时返回该参数。
charge_info
Object
否
付费方式信息，与请求参数相同。
详情请参见表11。
表10 configurations字段数据结构说明 参数
参数类型
是否必选
描述
type
String
是
节点类型。取值：
- 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。
- 副本集实例下该参数取值为“replica”。
- 单节点实例下该参数取值为“single”。
枚举值：
- mongos
- shard
- config
- replica
- single
configuration_id
String
是
参数组id。
表11 charge_info字段数据结构说明 参数
参数类型
是否必选
描述
charge_mode
String
是
计费模式。 取值范围：
- prePaid：预付费，即包年/包月。
- postPaid：后付费，即按需付费。
period_type
String
否
订购周期类型。 “charge_mode”为“prePaid”时生效，且为必选值。 取值范围：
- month：包月。
- year：包年。
period_num
Integer
否
“charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围：
- 当“period_type”为“month”时，取值为1~9。
- 当“period_type”为“year”时，取值为1~3
is_auto_renew
Boolean
否
创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 取值范围：
- true，表示自动续订。
- false，表示不自动续订，默认为该方式。
is_auto_pay
Boolean
否
创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 取值范围：
- true，表示自动从账户中支付
- false，表示手动从账户中支付，默认为该支付方式。
响应示例中参数“region”和“availability_zone”的值为示例值。
- 响应示例
{ "id": "39b6a1a278844ac48119d86512e0000bin02", "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "created": "2019-01-16 09:34:36", "status": "creating", "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "mode": "Sharding", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "flavor": [ { "type": "mongos", "num": "2", "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": "2", "spec_code": "dds.mongodb.c6.medium.4.shard", "size": "20" }, { "type": "config", "num": "1", "spec_code": "dds.mongodb.c6.large.2.config", "size": "20" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "enterprise_project_id": "", "ssl_option": "1", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f" }
状态码
详情请参见状态码。
错误码
详情请参见错误码。
