Creating a DB Instance

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

• en-us
• zh-cn

charge_info

No

MysqlChargeInfo object

Billing mode, which is yearly/monthly or pay-per-use (default setting).

region

Yes

String

Region ID.

The value cannot be empty. Obtain the parameter value from the enterprise administrator.

name

Yes

String

DB instance name.

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

The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

datastore

Yes

MysqlDatastore object

Database information.

mode

Yes

String

Instance type. Currently, only the cluster type is supported.

flavor_ref

Yes

String

Specification code.

vpc_id

Yes

String

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

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

subnet_id

Yes

String

Network ID. To obtain this 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.

security_group_id

No

String

Security group ID.

If network ACL is enabled, this parameter cannot be specified. If network ACL is disabled, this parameter is mandatory.

• 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: See "Querying Security Groups" in the Virtual Private Cloud API Reference.

configuration_id

No

String

Parameter template ID.

password

Yes

String

Database password. The password consists of 8 to 32 characters and contains at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^*-_=+?,()&). You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid.

backup_strategy

No

MysqlBackupStrategy object

Automated backup policy.

time_zone

No

String

Time zone. The default time zone is UTC.

availability_zone_mode

Yes

String

AZ type. The value can be single or multi.

master_availability_zone

No

String

Primary AZ.

• If availability_zone_mode is set to multi, this parameter is mandatory.
• If availability_zone_mode is set to single, this parameter cannot be specified.

slave_count

Yes

Integer

Number of read replicas. A maximum of nine read replicas can be created at a time.

tags

No

Array of MysqlTags objects

Tag list. Instances are created based on tag keys and values.

• {key} indicates the tag key. It must be unique and cannot be empty.
• {value} indicates the tag value, which can be empty.

To create instances with multiple tag keys and values, separate key-value pairs with commas (,). Up to 10 key-value pairs can be added.

enterprise_project_id

No

String

Enterprise project ID. This parameter is mandatory when the enterprise project is enabled.

dedicated_resource_id

No

String

Dedicated resource pool ID. This parameter is displayed only when the dedicated resource pool is enabled.

restore_point

No

MysqlRestorePoint object

Backup information.

charge_mode

Yes

String

Billing mode.

Valid value:

• prePaid: indicates the yearly/monthly billing mode.
• postPaid: indicates the pay-per-use billing mode.

period_type

No

String

Subscription period.

Valid value:

• month: The service is subscribed by month.
• year: The service is subscribed by year.
  NOTE:

  This parameter is valid and mandatory if charge_mode is set to prePaid.

period_num

No

Integer

Subscription duration. This parameter is valid and mandatory if charge_mode is set to prePaid.

Valid value:

• 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

No

String

Whether automatic renewal is enabled for yearly/monthly DB instances. The renewal period is the same as the original period and the order will be automatically paid during the subscription renewal.

• true: indicates that automatic renewal is enabled.
• false: indicates that automatic renewal is disabled. The default value is false.

is_auto_pay

No

String

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

• true: indicates the order will be automatically paid.
• false: indicates the order will be manually paid. The default value is false.

type

Yes

String

DB engine. Currently, only gaussdb-mysql is supported.

start_time

Yes

String

Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter.

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:

21:00-22:00

keep_days

No

String

Retention period of automated backups.

Value: 1 to 732

size

Yes

String

Disk size. The default value is 40 GB.

Value: 40 to 128000. The value must be a multiple of 10.

key

Yes

String

Tag key. It contains a maximum of 36 Unicode characters.

The value cannot be an empty string, a space, or left blank.

Only uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

value

Yes

String

Tag value. It contains a maximum of 43 Unicode characters.

It can be an empty string.

Only uppercase letters, lowercase letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

restore_time

No

Long

Point in time that data is restored to.

source_instance_id

Yes

String

Source instance ID.

backup_id

No

String

Backup file ID.

type

No

String

Backup type.

• If this parameter is left blank, backup_id cannot be left blank and data is restored using backup files by default.
• When the parameter is not empty, the value can be:
  • backup: indicates that data is restored using backup files.
  • timestamp: indicates that data is restored to a specified point of time.

instance

MysqlInstanceResponse object

Instance information.

job_id

String

ID of the task for creating a DB instance.

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

order_id

String

Order ID. This parameter is returned only when yearly/monthly 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 name can consist of 4 to 64 characters and must start with a letter. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_).

status

String

DB instance status.

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

datastore

MysqlDatastore object

Database information.

mode

String

DB instance type. Currently, only the cluster type is supported.

configuration_id

String

Parameter template ID.

port

String

Database port.

backup_strategy

MysqlBackupStrategy object

Automated backup policy.

enterprise_project_id

String

Enterprise project ID.

region

String

Region ID, which is the same as the request parameter.

availability_zone_mode

String

AZ mode, which is the same as the request parameter.

master_availability_zone

String

Primary AZ ID.

vpc_id

String

VPC ID, which is the same as the request parameter.

security_group_id

String

Security group ID, which is the same as the request parameter.

subnet_id

String

Subnet ID, which is the same as the request parameter.

flavor_ref

String

Specification code, which is the same as the request parameter.

charge_info

MysqlChargeInfo object

Billing mode, which is yearly/monthly or pay-per-use.

type

String

DB engine. Currently, only gaussdb-mysql is supported.

version

String

DB version.

A two-digit major version is returned. For details about how to obtain the version, see the name field returned by the Querying Version Information About a DB Engine.

start_time

String

Automated backup start time. The automated backup will be triggered within one hour after the time specified by this parameter.

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.

1. The HH value must be 1 greater than the hh value.
2. The values of mm and MM must be the same and must be set to 00.

keep_days

String

Automated backup retention days. Value: 1-732.

charge_mode

String

Billing mode, which is yearly/monthly or pay-per-use.

period_type

String

Subscription period.

Valid value:

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

Valid value:

• month
• year

period_num

Integer

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

Valid value:

• 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

String

Whether automatic renewal is enabled for yearly/monthly DB instances. The renewal period is the same as the original period and the order will be automatically paid during the subscription renewal.

• true: indicates that automatic renewal is enabled.
• false: indicates that automatic renewal is disabled. The default value is false.

is_auto_pay

String

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

• true: indicates the order will be automatically paid from your account. The default value is true.
• false: indicates the order will be manually paid.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.