Creating a DB Instance

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

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.

port

No

String

Database port.

password

Yes

String

Database password.

The password cannot be empty and must contain 8 to 32 characters, containing 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.

enterprise_project_id

No

String

Enterprise project ID. This parameter is suitable only for enterprise tenants.

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

region

Yes

String

Region ID.

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

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.

vpc_id

Yes

String

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

• Method 1: Log in to VPC console and view the VPC ID in the VPC details page.
• 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: 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: If you do not need to specify a security group, contact customer service.

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

charge_info

No

Object

Billing type, which is only pay-per-use.

For details, see Table 7.

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.

type

Yes

String

DB engine. Value:

GaussDB.

version

No

String

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

The following versions are supported:

• 1.1
• 1.2
• 1.3
• 1.4
• 2.3

mode

Yes

String

Distributed deployment model. The value enterprise (Enterprise Edition) and is case-insensitive.

replication_mode

Yes

String

Replication mode for the standby node.

Value:

sync

consistency

Yes

String

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

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 any of the following: 00, 15, 30, or 45.

Example value:

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

keep_days

No

Integer

Retention days for specific backup files.

The value ranges from 1 to 732. The default value 7.

type

Yes

String

Disk type.

The value is ULTRAHIGH (case-sensitive), indicating the SSD.

size

Yes

Integer

Disk size. For example, if this parameter is set to 40, 40 GB of storage is allocated to the created instance.

: 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. The value can only be postPaid, indicating pay-per-use billing.

instance

Object

Instance information.

For details, see Table 9.

job_id

String

Instance creation task ID.

This parameter is returned only when pay-per-use instances are created.

id

String

Instance ID.

name

String

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

This parameter is returned only when pay-per-use instances are 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.

enterprise_project_id

String

Project ID.

flavor_ref

String

Specification code. The value cannot be empty.

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. Only pay-per-use is supported.

For details, see Table 14.

type

String

DB engine. Value:

GaussDB

version

String

DB engine version.

mode

String

Distributed deployment model. The value enterprise (Enterprise Edition) and is case-insensitive.

replication_mode

String

Replication mode for the standby node.

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 any of the following: 00, 15, 30, or 45.

Example value:

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

If backup_strategy in the request body is empty, 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 backup_strategy in the request body is empty, 7 is returned for keep_days by default.

type

String

Disk type.

The value is ULTRAHIGH (case-sensitive), indicating the 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 information, which is pay-per-use.