Creating a DB Instance (v3)

name

Yes

String

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

datastore

Yes

Object

Database information.

For details, see Table 3.

ha

Yes

Object

Instance deployment model. For details, see Table 4.

configuration_id

No

String

Parameter template ID. If this parameter is not specified, the default parameter template is used and this parameter is not returned in the response body.

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.

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.

backup_strategy

No

Object

Backup policy.

For details, see Table 5.

flavor_ref

Yes

String

Specification code. The value cannot be empty. For details on how to obtain the GaussDB specification code, see DB Instance Specifications.

volume

Yes

Object

Volume information.

For details, see Table 6.

region

Yes

String

Region ID.

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.

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 "Querying VPCs" in 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 "Querying Subnets" in 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 "Querying Security Groups" in Virtual Private Cloud API Reference.

charge_info

No

Object

Billing mode.

For details, see Table 7.

sharding_num

No

Integer

This parameter is available only for distributed instances. Number of shards.

coordinator_num

No

Integer

This parameter is available only for distributed instances. Number of CNs. The number of CNs cannot exceed twice the number of shards.

type

Yes

String

DB engine. Value:

GaussDB. It is case-insensitive.

version

No

String

DB engine version. If this parameter is not specified, the latest version is used by default.

mode

Yes

String

Deployment model. Its value is enterprise for distributed instances and centralization_standard for primary/standby instances. It is case-insensitive.

consistency

Yes

String

Transaction consistency type. The value can be strong or eventual and is case-insensitive.

replication_mode

Yes

String

Replication mode for the standby node.

Valid value:

sync

start_time

Yes

String

Backup time window. The creation of an automated backup 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:

• 08:00-09:00
• 23:00-00:00

keep_days

No

Integer

Retention days for specific backup files.

Value: 0 to 732.

type

Yes

String

Disk type.

size

Yes

Integer

Disk size. For example, if this parameter is set to 40, 40 GB of storage is allocated to the created 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).

charge_mode

Yes

String

Billing mode.

instance

Object

Instance information.

For details, see Table 9.

job_id

String

Instance creation task ID.

id

String

Instance ID.

name

String

Instance name. Instances of the same type can have same names under the same tenant.

The value must consist of 4 to 64 characters and start with a letter. It is case-insensitive and contains only letters, 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 10.

ha

Object

Database deployment model.

For details, see Table 11.

replica_num

Integer

Number of replicas.

port

String

Database port, which is the same as the request parameter.

backup_strategy

Object

Automated backup policy.

For details, see Table 12.

flavor_ref

String

Specification code. The value cannot be empty. For details on how to obtain the GaussDB specification code, see DB Instance Specifications.

volume

Object

Volume information.

For details, see Table 13.

region

String

Region ID.

availability_zone

String

AZ ID.

vpc_id

String

VPC ID.

subnet_id

String

Network ID of the subnet.

security_group_id

String

Security group to which the instance belongs.

charge_info

Object

Payment mode.

For details, see Table 14.

type

String

DB engine. Value:

version

String

DB engine version.

mode

String

The value can be enterprise (Enterprise Edition). It is case-insensitive.

replication_mode

String

Replication mode for the standby node.

Valid value:

sync.

consistency

String

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

start_time

String

Backup time window. The creation of an automated backup 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:

• 08:00-09:00
• 23:00-00:00

If backup_strategy in the request body is left blank, 02:00-03:00 is returned for start_time by default.

keep_days

Integer

Retention days for specific backup files.

The value ranges from 1 to 732. If the backup_strategy field is not specified in the request body, keep_days in the response body is set to 7 days by default.

type

String

Disk type.

Its value is case-sensitive and can be:

• ULTRAHIGH, indicating SSD.

size

Integer

Disk size.

When creating a distributed 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).

charge_mode

String

Billing mode.