Restoring Data to a New DB Instance_Document Database Service_API Reference_APIs V3.0 (Recommended)

Description

This API is used to restore a backup to a new DB instance.

Restrictions

This API supports restoring backups to both the yearly/monthly and pay-per-use DB instances.
The database type of the destination DB instance must be the same as that of the source DB instance.
Currently, only replica set instances and cluster instances 4.0 and 4.2 can be restored to a new instance and to any point in time.

URI

URI format
POST https://{Endpoint}/v3/{project_id}/instances
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token obtained from IAM. For details, see Authentication.
project_id	string	path	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Requests

Parameter description

**Table 2** Parameter description
Name	Type	Mandatory	Description
name	String	Yes	The DB instance name. The instance name can be the same as an existing name. The instance name must contain 4 to 64 characters and must start with a letter. It is case sensitive and can contain letters, digits, hyphens (-), and underscores (_). It cannot contain other special characters.
datastore	Object	Yes	The database information. For details, see Table 3.
region	String	Yes	The region ID. The value cannot be empty. For details, see Regions and Endpoints.
availability_zone	String	Yes	AZ ID. The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.
vpc_id	String	Yes	VPC ID. For details about how to obtain this parameter value, see Virtual Private Cloud in the Virtual Private Cloud API Reference. The value cannot be empty. The string length and whether the string complying with UUID regular expression rules are verified.
subnet_id	String	Yes	Subnet ID. For details about how to obtain this parameter value, see Subnet in the Virtual Private Cloud API Reference.
security_group_id	String	Yes	Specifies the ID list of the security groups which a specified DB instance belongs to. To use multiple security groups for a DDS instance, choose Service Tickets > Create Service Ticket in the upper right corner of the management console to apply for the required permissions. You can add up to 10 security group IDs for each instance and separate them with commas (,). You can obtain it in either of the following ways: For details about how to obtain this parameter value, see Security Group in the Virtual Private Cloud API Reference.
port	String	No	Database access port. Value range: 2100 to 65535 (excluding 12017 and 33071) If this parameter is not transferred, the port of the created DB instance is 8635 by default.
password	String	No	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 ~!@#%^*-_=+? Enter a strong password to improve security, preventing security risks such as brute force cracking. If this parameter is not transferred, set a password for the instance before connecting to the instance. For details, see Resetting the Administrator Password.
disk_encryption_id	String	No	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.
mode	String	Yes	DB instance type. Cluster and replica set instances are supported. The value can be: Sharding ReplicaSet
configurations	Array of objects	No	Parameter group configuration information. For more information, see Table 4. If this parameter is not transferred, the default parameter group is used.
flavor	Array of objects	Yes	Instance specifications. For more information, see Table 5. For details about how to obtain the value, see the parameter value in Querying Database Specifications.
backup_strategy	Object	No	Advanced backup policy. For more information, see Table 6.
enterprise_project_id	String	No	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	String	No	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.
dss_pool_id	String	No	The dedicated storage ID of the DeC user. The value is left blank by default. Only DeC users can set this parameter.
server_group_policies	Array of strings	No	The names of the policies associated with the ECS group of the DeC user. Available values include: anti-affinity indicates that anti-affinity deployment is enabled for the DDS instance. To ensure high availability, the primary, secondary, and hidden nodes are created on different physical machines. If this parameter is not transferred for DeC users, anti-affinity deployment is disabled by default. Only DeC users can set this parameter.
tags	Array of objects	No	The tag list. A maximum of 20 tags can be added for each instance. For details, see Table 7.
charge_info	Object	No	Billing mode, which includes yearly/monthly and pay-per-use. The default billing mode is pay-per-use. For details, see Table 8.

**Table 3** Data structure description of feild **datastore**
Parameter	Type	Mandatory	Description
type	String	Yes	Database type. The value is DDS-Community.
version	String	Yes	Database version. Versions 4.4, 4.2, 4.0, and 3.4 are supported. The value can be 4.4, 4.2, 4.0, or 3.4.
storage_engine	String	Yes	The storage engine. DDS supports the WiredTiger and RocksDB storage engines. If the database version is 4.2 and the storage engine is RocksDB, the value is rocksDB. If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is wiredTiger.

**Table 4** Data structure description of the configurations field
Parameter	Type	Mandatory	Description
type	String	Yes	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. For a single node instance, the value is single. Enumerated values: mongos shard config replica single
configuration_id	String	Yes	Parameter group ID

**Table 5** Data structure of the flavor field
Name	Type	Mandatory	Description
type	String	Yes	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. For a single node instance, the value is single.
num	String	Yes	The node quantity. Valid value: In a cluster instance, the number of mongos nodes ranges from 2 to 32. config: The value is 1. replica: The value is 1. single: The value is 1.
storage	String	No	Disk type. Valid value: ULTRAHIGH, which indicates the type SSD. This parameter is valid for the shard and config nodes of a cluster instance and for replica set instances. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes.
size	String	No	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. In a replica set instance, the disk size ranges from 10 GB to 3000 GB and must be greater than or equal to the disk size of the original instance. In a single node instance, the disk size ranges from 10 GB to 1000 GB and must be greater than or equal to the disk size of the original instance.
spec_code	String	Yes	The resource specification code. For details about how to obtain the code, see the value of spec_code in Querying Database Specifications.

**Table 6** backup_strategy field data structure description
Name	Type	Mandatory	Description
start_time	String	Yes	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	String	No	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.

**Table 7** Data structure description of field **tags**
Parameter	Type	Mandatory	Description
key	String	Yes	The tag key. It can contain a maximum of 36 Unicode characters. The key cannot be left blank or an empty string. The character set is as follows: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
value	String	Yes	The tag value. It can contain a maximum of 43 Unicode characters. The value can be an empty string. The character set is as follows: A-Z, a-z, 0-9, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

**Table 8** Data structure of the charge_info field
Parameter	Type	Mandatory	Description
charge_mode	String	Yes	Billing mode. Value range: prePaid: indicates the yearly/monthly billing mode. postPaid: indicates the pay-per-use billing mode.
period_type	String	No	Subscription period. This parameter is valid and mandatory only when charge_mode is set to prePaid. Value range: month: The service is subscribed by month. year: The service is subscribed by year.
period_num	Integer	No	This parameter is valid and mandatory only when charge_mode is set to prePaid. Value range: If period_type is set to month, the parameter value ranges from 1 to 9. If period_type is set to year, the parameter value ranges from 1 to 3.
is_auto_renew	Boolean	No	Whether automatic renewal is enabled for yearly/monthly instances. The renewal period is the same as the original period and the order will be automatically paid during the subscription renewal. Value range: true: indicates that the subscription is automatically renewed. false: indicates that the subscription is not automatically renewed. The default value is false.
is_auto_pay	Boolean	No	Payment method. When creating a yearly/monthly DB instance, you can specify whether to automatically pay with your account. This parameter does not affect the payment method of automatic renewal. Value range: true: indicates that the order is automatically paid from the account. false: indicates that the fee is manually paid from the account. This payment method is used by default.

The values of region and availability_zone are used as examples.

Example Request

Restoring a backup to a new cluster instance:

{
  "name": "test-cluster-01",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.2",
    "storage_engine": "wiredTiger"
  },
  "region": "aaa",
  "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": "******",
  "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,
      "storage": "ULTRAHIGH",
      "size": 20,
      "spec_code": "dds.mongodb.c6.medium.4.shard"
    },
    {
      "type": "config",
      "num": 1,
      "storage": "ULTRAHIGH",
      "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"
  ],
  "tags": [
    {
      "key": "dds001",
      "value": "dds001"
    }
  ]
}

Restoring a backup to a new replica set instance:

{
    "name": "test-replicaset",
    "datastore": {
      "type": "DDS-Community",
      "version": "3.4",
      "storage_engine": "wiredTiger"
    },
    "region": "aaa",
    "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": "******",
    "mode": "ReplicaSet",
    "configurations": [
        {
            "type": "replica",
            "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02"
        }
    ],
    "flavor": [
        {
            "type": "replica",
            "num": "1",
            "storage": "ULTRAHIGH",
            "size": "30",
            "spec_code": "dds.mongodb.s2.medium.4.shard"
        }
    ],
    "backup_strategy": {
        "start_time": "08:15-09:15",
        "keep_days": "8"
    },
    "ssl_option": "1",
    "tags" : [{ 
       "key" : "dds001", 
       "value" : "dds001" 
    }]
}

Restoring a backup to a new single node instance:

{
  "name": "test-singlenode",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.2",
    "storage_engine": "wiredTiger"
  },
  "region": "aaa",
  "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": "******",
  "mode": "Single",
  "configurations": [
    {
      "type": "single",
      "configuration_id": "b8e962e66ede47609a94cba591735b49pr02"
    }
  ],
  "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",
  "tags" : [{ 
    "key" : "dds001", 
    "value" : "dds001" 
  }]
}

Restoring a backup to a new replica set instance at a point in time:

{
  "name": "replica-liuyunj1",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.2",
    "storage_engine": "wiredTiger"
  },
  "region": "aaa",
  "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",
  "mode": "ReplicaSet",
  "flavor": [
    {
      "type": "replica",
      "num": 1,
      "storage": "ULTRAHIGH",
      "size": 100,
      "spec_code": "dds.mongodb.c6.large.2.repset"
    }
  ],
  "backup_strategy": {
    "start_time": "08:00-09:00",
    "keep_days": "8"
  },
  "ssl_option": "1",
  "tags" : [{ 
    "key" : "dds001", 
    "value" : "dds001" 
  }]
}

Responses

Parameter description

**Table 9** Parameter description
Name	Type	Mandatory	Description
id	String	No	The DB instance ID.
name	String	No	Instance name, which is the same as the request parameter.
datastore	Object	No	Database information, which is the same as the request parameter. For more information, see Table 10.
created	String	No	Creation time, which is in the yyyy-mm-dd hh:mm:ss format.
status	String	No	The DB instance status. The value is creating.
region	String	No	Region ID, which is the same as the request parameter.
availability_zone	String	No	AZ ID, which is the same as the request parameter.
vpc_id	String	No	VPC ID, which is the same as the request parameter.
subnet_id	String	No	Subnet ID, which is the same as the request parameter.
security_group_id	String	No	Specifies the ID list of the security groups which a DB instance belongs to, which is the same as the request parameter.
port	Integer	No	Database access port.
disk_encryption_id	String	No	The ID of the disk encryption key. It is the same as the request parameter.
mode	String	No	Instance type, which is the same as the request parameter.
configurations	Array of objects	No	Parameter group configuration information. For details, see Table 11.
flavor	Array of objects	No	Instance specification, which is the same as the request parameter. For more information, see Table 5.
backup_strategy	Object	No	Advanced backup policy, which is the same as the request parameter. For more information, see Table 6.
enterprise_project_id	String	No	Enterprise project ID. If the value is 0, the resource belongs to the default enterprise project.
dss_pool_id	String	No	The DSS storage pool ID of the DeC user.
job_id	String	No	The ID of the workflow for creating a DB instance.
ssl_option	String	No	Indicates whether to enable SSL, which functions the same as the request parameter.
tags	Array of objects	No	Tag list, which is the same as the request parameter. For details, see Table 14.
order_id	String	No	The ID of the order for creating an instance. This parameter is returned only when you create a yearly/monthly instance.
charge_info	Object	No	Billing mode, which is the same as the request parameter. For details, see Table 15.

**Table 10** Data structure description of feild **datastore**
Parameter	Type	Mandatory	Description
type	String	Yes	Database type. The value is DDS-Community.
version	String	Yes	Database version. Versions 4.4, 4.2, 4.0, and 3.4 are supported. The value can be 4.4, 4.2, 4.0, or 3.4.
storage_engine	String	Yes	The storage engine. DDS supports the WiredTiger and RocksDB storage engines. If the database version is 4.2 and the storage engine is RocksDB, the value is rocksDB. If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is wiredTiger.

**Table 11** Data structure description of the configurations field
Parameter	Type	Mandatory	Description
type	String	Yes	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. For a single node instance, the value is single. Enumerated values: mongos shard config replica single
configuration_id	String	Yes	Parameter group ID

**Table 12** Data structure of the flavor field
Name	Type	Mandatory	Description
type	String	Yes	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. For a single node instance, the value is single.
num	String	Yes	Number of nodes or groups. Valid value: If the value of type is mongos, num indicates the number of mongos nodes in the cluster instance. The value ranges from 2 to 16. If the value of type is shard, num indicates the number of shard groups in the cluster instance. The value ranges from 2 to 16. If the value of type is config, num indicates the number of config groups in the cluster instance. The value can only be 1. If the value of type is replica, num indicates the number of replica nodes in the replica set instance. The value can be 3, 5, or 7. If the value of type is single, num indicates the number of nodes in a single node instance. The value can only be 1.
storage	String	No	Disk type.
size	String	No	Disk size. This parameter is mandatory for all nodes except mongos. This parameter is invalid for the mongos nodes. The value must be a multiple of 10. The unit is GB. For a cluster instance, the storage space of a shard node can be 10 to 2,000 GB, and the config storage space is 20 GB. This parameter is invalid for mongos nodes. Therefore, you do not need to specify the storage space for mongos nodes. For a replica set instance, the value ranges from 10 to 3000. For a single node instance, the value ranges from 10 to 1000.
spec_code	String	Yes	Resource specification code. For details about how to obtain the code, see the value of response parameter spec_code in Querying Database Specifications. In a cluster instance, multiple specifications need to be specified. All specifications must be of the same series, that is, general-purpose (s6), enhanced (c3), or enhanced II (c6). Example: dds.mongodb.s6.large.4.mongos and dds.mongodb.s6.large.4.config belong to the same specification series. dds.mongodb.s6.large.4.mongos and dds.mongodb.c3.large.4.config are not of the same specification series.

**Table 13** Data structure of the backup_strategy field
Name	Type	Mandatory	Description
start_time	String	Yes	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. If this parameter is not specified, the default backup time window is set to 00:00-01:00. Example value: 23:00-00:00
keep_days	String	No	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 specified, the automated backup policy is enabled by default. Backup files are stored for seven days by default.

**Table 14** Data structure description of field **tags**
Parameter	Type	Mandatory	Description
key	String	Yes	The tag key. It can contain a maximum of 36 Unicode characters. The key cannot be left blank or an empty string. The character set is as follows: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).
value	String	Yes	The tag value. It can contain a maximum of 43 Unicode characters. The value can be an empty string. The character set is as follows: A-Z, a-z, 0-9, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

**Table 15** Data structure of the charge_info field
Parameter	Type	Mandatory	Description
charge_mode	String	Yes	Billing mode. Value range: prePaid: indicates the yearly/monthly billing mode. postPaid: indicates the pay-per-use billing mode.
period_type	String	No	Subscription period. This parameter is valid and mandatory only when charge_mode is set to prePaid. Value range: month: The service is subscribed by month. year: The service is subscribed by year.
period_num	Integer	No	This parameter is valid and mandatory only when charge_mode is set to prePaid. Value range: If period_type is set to month, the parameter value ranges from 1 to 9. If period_type is set to year, the parameter value ranges from 1 to 3.
is_auto_renew	Boolean	No	Whether automatic renewal is enabled for yearly/monthly instances. The renewal period is the same as the original period and the order will be automatically paid during the subscription renewal. Value range: true: indicates that the subscription is automatically renewed. false: indicates that the subscription is not automatically renewed. The default value is false.
is_auto_pay	Boolean	No	Payment method. When creating a yearly/monthly DB instance, you can specify whether to automatically pay with your account. This parameter does not affect the payment method of automatic renewal. Value range: true: indicates that the order is automatically paid from the account. false: indicates that the fee is manually paid from the account. This payment method is used by default.

The values of region and availability_zone are used as examples.

Response example

Cluster instance:

{
  "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",
      "storage": "ULTRAHIGH",
      "spec_code": "dds.mongodb.c6.medium.4.shard",
      "size": "20"
    },
    {
      "type": "config",
      "num": "1",
      "storage": "ULTRAHIGH",
      "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",
  "tags" : [{ 
     "key" : "dds001", 
     "value" : "dds001" 
   }]
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Restoring Data to a New DB Instance