Restoring Data to a New DB Instance
Function
This API is used to restore a DB instance using the backup.
Constraints
- The database type of the destination DB instance must be the same as that of the source DB instance.
URI
Requests
- Parameter description
Table 2 Parameter description Name
Mandatory
Type
Description
name
Yes
String
Specifies the DB instance name. The DB instance name of the same DB engine is unique for the same tenant.
The value must be 4 to 64 characters in length and start with a letter (from A to Z or from a to z). It is case-sensitive and can contain only letters, digits (from 0 to 9), hyphens (-), and underscores (_).
availability_zone
Yes
String
Specifies the AZ ID.
vpc_id
Yes
String
Indicates the VPC ID.
The value cannot be empty. The string length and whether the string complying with UUID regular expression rules are verified.
subnet_id
Yes
String
Specifies the subnet ID.
security_group_id
Yes
String
Specifies the ID of the security group where a specified DB instance belongs to.
password
No
String
Specifies the database password.
The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^*-_=+?
You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking.
disk_encryption_id
No
String
Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules.
If this parameter is not transferred, disk encryption is not performed.
flavor
Yes
Array of objects
Specifies the instance specifications. For more information, see Table 4.
For details about how to obtain the value, see the parameter value in Querying All DB Instance Specifications.
restore_point
Yes
Object
Specifies the details about the backup to be restored to a new DB instance. For more information, see Table 3.
backup_strategy
No
Object
Specifies the advanced backup policy. For more information, see Table 5.
enterprise_project_id
No
String
Specifies the enterprise project ID.
- This parameter is not transferred for users who have not enabled the enterprise multi-project service.
- If this parameter is not transferred for a user who has enabled the enterprise multi-project service, the value is the default enterprise project.
ssl_option
No
String
Specifies whether to enable or disable SSL.
Valid value:
- The value 0 indicates that SSL is disabled by default.
- The value 1 indicates that SSL is enabled by default.
If this parameter is not transferred, SSL is enabled by default.
Table 3 restore_point field data structure description Name
Mandatory
Type
Description
backup_id
Yes
String
Specifies the ID of the backup to be restored.
Table 4 flavor field data structure description Name
Mandatory
Type
Description
type
Yes
String
Specifies the node type.
Valid value:
- For a cluster instance, the value can be mongos, shard, or config.
- For a replica set instance, the value is replica.
num
Yes
Integer
Specifies node quantity.
Valid value:
- config: The value is 1.
- replica: The value is 1.
size
This parameter is optional for all nodes except mongos and invalid for mongos.
Integer
Specifies the disk size.
The value must be a multiple of 10. The unit is GB.
- In a cluster instance, the shard size ranges from 10 GB to 2000 GB and must be greater than or equal to the disk size of the original instance. The config size can only be 20 GB. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.
spec_code
Yes
String
Specifies the resource specification code. For details about how to obtain the value, see the parameter value in Querying All DB Instance Specifications.
Table 5 backup_strategy field data structure description Name
Mandatory
Type
Description
start_time
Yes
String
Specifies the backup time window. Automated backups will be triggered during the backup time window.
The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
- The HH value must be 1 greater than the hh value.
- The values of mm and MM must be the same and must be set to 00.
Example value:
23:00-00:00
keep_days
No
String
Specifies the number of days to retain the generated backup files.
The value range is from 0 to 732.
- If this parameter is set to 0, the automated backup policy is not set.
- If this parameter is not transferred, the automated backup policy is enabled by default. Backup files are stored for seven days by default.
The values of region and availability_zone are used as examples.
- Request header
POST https://DDS endpoint/v3/{project_id}/instances
- Example request
Restore the backup of a cluster to a new DB instance.
{ "name": "test-cluster-01", "availability_zone": "bbb", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "Test#%0_", "restore_point": { "backup_id": "8f643d252d834a4c916b2db4322f99552734" }, "flavor": [{ "type": "mongos", "num": 2, "spec_code": "dds.c3.medium.4.mongos" }, { "type": "shard", "size": 40, "spec_code": "dds.c3.medium.4.shard" }, { "type": "config", "num": 1, "size": 20, "spec_code": "dds.c3.large.2.config" } ], "backup_strategy": { "start_time": "23:00-00:00", "keep_days": "8" } }
Restore the backup of a replica set instance:
{ "name": "test-replicaset", "availability_zone": "bbb", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "Test#%0_", "restore_point": { "backup_id": "8f643d252d834a4c916b2db4322f99552734" }, "flavor": [ { "type": "replica", "num": 1, "spec_code": "dds.s2.medium.4.shard" } ], "backup_strategy": { "start_time": "23:00-00:00", "keep_days": "8" } }
Responses
- Parameter description
Table 6 Parameter description Name
Type
Description
id
String
Indicates the DB instance ID.
name
String
Same as the request parameter.
datastore
Object
Indicates the database information, which is the same as the request parameter. For more information, see Table 3.
created
String
Indicates the creation time in the following format: yyyy-mm-dd hh:mm:ss.
status
String
Indicates the DB instance status. The value is creating.
region
String
Indicates the region ID, which is the same as the request parameter.
availability_zone
String
Indicates the AZ ID, which is the same as the request parameter.
vpc_id
String
Indicates the VPC ID, which is the same as the request parameter.
subnet_id
String
Indicates the subnet ID, which is the same as the request parameter.
security_group_id
String
Indicates the ID of the security group to which the instance belongs, which is the same as the request parameter.
disk_encryption_id
String
Indicates the ID of the disk encryption key, which is the same as the request parameter.
mode
String
Indicates the instance type, which is the same as the request parameter.
flavor
Array of objects
Indicates the instance specification, which is the same as the request parameter. For more information, see Table 4.
backup_strategy
Object
Indicates the advanced backup policy, which is the same as the request parameter. For more information, see Table 5.
enterprise_project_id
String
Indicates the enterprise project ID. If the value is 0, the resource belongs to the default enterprise project.
job_id
String
Indicates the ID of the workflow for creating a DB instance.
The values of region and availability_zone are used as examples.
- Response example
{ "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": "bbb", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "disk_encryption_id": "", "mode": "Sharding", "flavor": [ { "type": "mongos", "num": 2, "spec_code": "dds.c3.medium.4.mongos" }, { "type": "shard", "num": 2, "spec_code": "dds.c3.medium.4.shard", "size": 20 }, { "type": "config", "num": 1, "spec_code": "dds.c3.large.2.config", "size": 20 } ], "backup_strategy": { "start_time": "23:00-00:00", "keep_days": "8" }, "enterprise_project_id": "", "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f" }
Replica set instance:
{ "id": "46dfadfd2b674585a430217f23606cd7in02", "name": "test-replicaset", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "created": "2019-01-16 09:33:08", "status": "creating", "region": "aaa", "availability_zone": "bbb", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "disk_encryption_id": "", "mode": "ReplicaSet", "flavor": [ { "type": "replica", "num": 1, "spec_code": "dds.s2.medium.4.shard", "size": 30 } ], "backup_strategy": { "start_time": "23:00-00:00", "keep_days": "7" }, "enterprise_project_id": "", "job_id": "2408417d-fd4b-40ae-bec6-e09ce594eb5f" }
Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot