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.

X-Language

No

String

Language.

charge_info

No

MysqlChargeInfo object

Billing mode.

region

Yes

String

Region ID.

The value cannot be empty. To obtain this value, see Regions and Endpoints.

name

Yes

String

DB instance name.

DB instances of the same type can have same names under the same tenant.

The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_).

datastore

Yes

MysqlDatastore object

Database information.

mode

Yes

String

DB instance type. Its value is Cluster.

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

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

charge_mode

Yes

String

Billing mode.

Value: postPaid

type

Yes

String

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

version

Yes

String

DB version.

For details about supported DB versions, see Querying Version Information About a DB Engine.

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

Automated backup retention days. Value: 1-732.

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.

instance

MysqlInstanceResponse object

DB instance information.

job_id

String

DB instance creation task ID.

id

String

DB instance ID.

name

String

DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-insensitive and contains only letters, digits, hyphens (-), and underscores (_).

status

String

DB instance status.

datastore

MysqlDatastore object

Database information.

mode

String

DB instance type. Its value is Cluster.

configuration_id

String

Parameter template ID.

port

String

Database port.

backup_strategy

MysqlBackupStrategy object

Automated backup policy.

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.

type

String

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

version

String

DB version.

To obtain details about supported DB engine versions, call the API for querying the DB engine versions.

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.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.