Restoring Data to a New instance

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

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:

• To deploy a DB instance in the same AZ, enter three same AZ IDs.
• To deploy a DB instance across three different AZs, enter three different AZ IDs.

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:

• Method 1: Log in to the VPC console and view the VPC ID in the VPC details.
• Method 2: See the section "Querying VPCs" in the Virtual Private Cloud API Reference.

subnet_id

Yes

String

Network ID of the subnet. To obtain this parameter value, use either of the following methods:

• Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
• Method 2: See section "Querying Subnets" in the Virtual Private Cloud API Reference.

security_group_id

Yes

String

Security group which the instance is associated with. To obtain this parameter value, use either of the following methods:

• Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
• Method 2: See the section "Querying Security Groups" in the Virtual Private Cloud API Reference.

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.

• If this parameter is not specified, GaussDB uses UTC by default.

• If this parameter is specified, the value ranges from UTC-12:00 to UTC+12:00 at the full hour. For example, the parameter can be UTC+08:00 rather than UTC+08:30.

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).

charge_mode

Yes

String

Billing mode. postPaid: pay-per-use billing.

instance_id

Yes

String

Source instance ID.

backup_id

No

String

ID of the backup to be restored.

instance

Object

Instance information.

For details, see Table 7.

job_id

String

Task ID for restoring data to a new DB instance.

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.

type

String

DB engine.

Value:

• GaussDB

version

String

DB engine version.

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:

• strong
• eventual

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).

start_time

String

This field has been deprecated.

keep_days

Integer

This field has been deprecated.

charge_mode

String

Billing mode. postPaid: pay-per-use billing.