Restoring Data to a New instance

project_id

Yes

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

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.

The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.

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.

disk_encryption_id

No

String

Key ID for disk encryption. The default value is empty.

vpc_id

Yes

String

VPC ID. To obtain this parameter value, use the following methods:

• Method 1: Log in to VPC console and view the VPC ID in the VPC details page.
• Method 2: Query the VPC ID through the VPC API. For details, see Querying VPCs.
• 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 VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
• Method 2: Query the subnet ID through the VPC API. For details, see Querying Subnets.
• 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 VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
• Method 2: Query the security group through the VPC API. For details, see Querying Security Groups.
• 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 or yearly/monthly.

For details, see Table 4.

backup_strategy

No

Object

Automated backup policy.

For details, see Table 6.

restore_point

Yes

Object

Restoration information.

For details, see Table 5.

enable_parallel_restore

No

Boolean

Whether to support parallel restoration. If this parameter is not specified, the function is not supported for instances of the enterprise edition, and supported for primary/standby instances by default.

configuration_id

No

String

Parameter template ID. If this parameter is not specified, the default parameter template is used.

enterprise_project_id

No

String

Enterprise project ID.

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 in the International website 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.

enable_force_switch

No

Boolean

Whether to forcibly promote a standby node to primary. The value can only be true or false.

true: The function is enabled. false (default value): The function is disabled. Only 1.2.2 and later versions are supported.

type

Yes

String

Disk type.

LOCALSSD indicates the local SSD and is available for primary/standby instances. ULTRAHIGH indicates the cloud disk and is available for distributed instances in the independent deployment. The value is case-sensitive.

ULTRAHIGH: local disk. ESSD: extreme SSD.

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. prePaid: yearly/monthly billing.

period_type

No

string

Subscription period type. month: The service is subscribed by month. year: The service is subscribed by year. This parameter is valid and mandatory only when charge_mode is set to prePaid.

period_num

No

integer

This parameter is valid and mandatory only when charge_mode is set to prePaid.

Value range:

When period_type is set to month, the parameter value ranges from 1 to 9. When period_type is set to year, the parameter value ranges from 1 to 3.

When a floating-point value is transferred, the value is automatically truncated to an integer.

is_auto_renew

No

boolean

Whether automatic renewal is enabled for yearly/monthly instances. If you enable this function, the order will be automatically paid during the subscription renewal. The default renewal period is one month for monthly subscription and one year for yearly subscription. The renewal period can be configured as needed.

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

No

boolean

Whether the order will be automatically paid after yearly/monthly instances are created. This parameter does not affect the payment mode of automatic renewal.

true: indicates that the order is automatically paid from the account. false: indicates that the order is manually paid from the account. The default value is false.

instance_id

Yes

String

Source instance ID.

backup_id

No

String

ID of the backup to be restored.

type

No

String

Restoration type. Value:

• backup: indicates data is restored using backups. In this mode, type is optional and backup_id is mandatory.
• timestamp: indicates data is restored using point-in-time recovery (PITR). In this mode, type is mandatory and restore_time is mandatory.

Value:

• backup
• timestamp

restore_time

No

Long

Time point of data restoration in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.

start_time

Yes

String

Deprecated field. Leave it blank.

keep_days

No

Integer

Deprecated field. Leave it blank.

instance

Object

Instance information.

For details, see Table 8.

job_id

String

Task ID for restoring data to a new DB instance.

order_id

string

ID of the order for creating an instance.

This parameter is returned only when a yearly/monthly instance is created.

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

ha

Object

Instance deployment model.

For details, see Table 10.

port

String

Database port. The default value is 8000.

enterprise_project_id

String

Project ID.

volume

Object

Volume information.

For details, see Table 11.

backup_strategy

Object

Automated backup policy.

For details, see Table 12.

replica_num

Integer

Number of replicas.

region

String

Region ID.

The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.

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.

The value cannot be empty. For details about how to obtain this parameter value, see Regions and Endpoints.

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 or yearly/monthly.

For details, see Table 13.

type

String

DB engine.

Value:

• GaussDB

version

String

DB engine version.

mode

String

For distributed instances, the return value is enterprise (enterprise edition). For primary/standby instances, the return value is centralization_standard (primary/standby edition).

replication_mode

String

Replication mode for the standby node.

Value:

sync.

Value:

• sync

consistency

String

(GaussDB reserved parameter) Transaction consistency type. The value can be strong or eventual.

Value:

• strong
• eventual

type

String

Disk type.

Its value is case-sensitive and can be:

• ULTRAHIGH: indicates the SSD.
• ESSD: indicates the extreme SSD.

Value:

• ULTRAHIGH
• ESSD

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. prePaid: yearly/monthly billing.

period_type

string

Subscription period type. month: The service is subscribed by month. year: The service is subscribed by year. This parameter is valid and mandatory only when charge_mode is set to prePaid.

period_num

integer

This parameter is valid and mandatory only when charge_mode is set to prePaid.

Value range:

When period_type is set to month, the parameter value ranges from 1 to 9. When period_type is set to year, the parameter value ranges from 1 to 3.

is_auto_renew

boolean

Whether automatic renewal is enabled for yearly/monthly instances. If you enable this function, the order will be automatically paid during the subscription renewal. The default renewal period is one month for monthly subscription and one year for yearly subscription. The renewal period can be configured as needed.

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

Whether the order will be automatically paid after yearly/monthly instances are created. This parameter does not affect the payment mode of automatic renewal.

true: indicates that the order is automatically paid from the account. false (default value): indicates that the order is manually paid from the account.