Restoring Data to a New instance
Function
This API is used to restore data to a new DB instance using backups. Before calling this API:
- Learn how to authenticate this API.
Constraints
The DB engine versions and instance types of the original and new instances must be the same.
The specifications of the new instance must be greater than or equal to those of the original instance.
URI
POST https://{Endpoint}/v3/{project_id}/instances
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Explanation: Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
DB instance name. Instances of the same type can have same names under the same tenant. The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_). |
availability_zone |
Yes |
String |
AZ ID. The value cannot be empty. You can deploy GaussDB in the same AZ or across three different AZs, and use commas (,) to separate AZs. For example:
|
flavor_ref |
Yes |
String |
Specification code. The value cannot be empty. To obtain its value, see the spec_code field in Querying Instance Specifications. |
volume |
Yes |
Object |
Volume information. For details, see Table 3. |
vpc_id |
Yes |
String |
VPC ID. To obtain this parameter value, use the following methods:
|
subnet_id |
Yes |
String |
Network ID of the subnet. To obtain this parameter value, use either of the following methods:
|
security_group_id |
Yes |
String |
Security group which the instance is associated with. To obtain this parameter value, use either of the following methods:
|
password |
Yes |
String |
Database password. The GaussDB database password must: Consist of 8 to 32 characters, including at least three of the following: uppercase letters, lowercase letters, digits, and special characters ~!@#%^*-_=+?, Enter a strong password to improve security, preventing security risks such as brute force cracking. |
charge_info |
No |
Object |
Billing mode, which can be pay-per-use. For details, see Table 4. |
backup_strategy |
No |
Object |
Automated backup policy. |
restore_point |
Yes |
Object |
Restoration information. For details, see Table 5. |
configuration_id |
No |
String |
Parameter template ID. If this parameter is not specified, the default parameter template is used. |
port |
No |
String |
Port number used by the database to provide services for external systems, ranging from 1024 to 39998. If you do not configure this parameter, the default value 8000 is used. The following ports are not allowed: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 12016, 12017, 20049, 20050, 21731, 21732, 32122, 32123, and 32124. |
time_zone |
No |
String |
UTC time zone.
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Disk type. |
size |
Yes |
Integer |
Storage space, which must be at least equal to that of the original instance. For example, if this parameter is set to 40, 40 GB of storage is allocated to the instance. ECS deployment: The value is from (Number of shards x 40 GB) to (Number of shards x 16 TB) and must be a multiple of (Number of shards x 4 GB). |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
instance |
Object |
Instance information. For details, see Table 7. |
job_id |
String |
Task ID for restoring data to a new DB instance. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
name |
String |
DB instance name. Instances of the same type can have same names under the same tenant. The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_). |
status |
String |
Instance status. For example, BUILD indicates that the instance is being created. |
datastore |
Object |
Database information. For details, see Table 8. |
ha |
Object |
Instance deployment model. For details, see Table 9. |
port |
String |
Database port. The default value is 8000. |
volume |
Object |
Volume information. For details, see Table 10. |
backup_strategy |
Object |
Automated backup policy. For details, see Table 11. |
replica_num |
Integer |
Number of replicas. |
region |
String |
Region ID. |
flavor_ref |
String |
Specification code. |
availability_zone |
String |
AZ ID. You can deploy your instance in the same AZ or across three different AZs, and use commas (,) to separate AZs. |
vpc_id |
String |
VPC ID. |
subnet_id |
String |
Subnet ID. |
security_group_id |
String |
Security group ID. |
charge_info |
Object |
Billing mode, which can be pay-per-use. For details, see Table 12. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
DB engine. Value:
|
version |
String |
DB engine version. |
Parameter |
Type |
Description |
---|---|---|
mode |
String |
For distributed instances, the return value is enterprise (enterprise edition). For centralized instances, the return value is centralization_standard (centralized edition). |
replication_mode |
String |
Replication mode for the standby node. The value can only be set to sync, indicating that data is synchronized in synchronous mode. |
consistency |
String |
(GaussDB reserved parameter) Transaction consistency type. The value can be strong or eventual. Value:
|
Parameter |
Type |
Description |
---|---|---|
type |
String |
Disk type. |
size |
Integer |
Disk size. When restoring a distributed GaussDB instance, you need to specify the size to be a multiple of (Number of shards x 4 GB). Value range: (Number of shards x 40 GB) to (Number of shards x 16 TB). |
Example Request
-
POST https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/instances { "name": "targetInst", "availability_zone": "aaa,bbb,ccc", "volume": { "size": 160 }, "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "password": "******", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14", "backup_id": "2f4ddb93b9014b0893d81d2e472f30febr14" }, "configuration_id": "52e86e87445847a79bf807ceda213165pr01", "port": 8000, "time_zone": "UTC+04:00" }
Response
{
"instance": {
"id": "2gfdsh844a4023a776fc5c5fb71fb4in14",
"name": "gaussdb-instance-rep2",
"status": "BUILD",
"datastore": {
"type": "GaussDB",
"version": "1.4"
},
"ha": {
"mode": "enterprise",
"consistency": "strong",
"replication_mode": "sync"
},
"volume": {
"size": 160
},
"port": "8000",
"replica_num": 3,
"region": "regionA",
"availability_zone": "aaa,bbb,ccc",
"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
"charge_info": {
"charge_mode": "postPaid"
},
},
"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.