Creating an 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.

name

Yes

String

Instance name, which can be the same as an existing instance name.

The name can contain 4 to 64 bytes and must start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

datastore

Yes

Datastore object

Database information.

region

Yes

String

Region ID.

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

availability_zone

Yes

String

AZ ID.

For details about the value, see az_status returned in Querying Instance Specifications. If an instance can be created across three AZs, separate multiple AZ IDs by commas (,).

vpc_id

Yes

String

VPC ID. You can obtain the value with 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: Query the VPC ID using the VPC API. For details, see Querying VPCs.

subnet_id

Yes

String

Subnet ID. You can obtain the subnet ID with 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: Query the subnet ID through the VPC API. For details, see Querying Subnets.

security_group_id

Yes

String

Security group ID. You can obtain the security group ID with either of the following methods:

• Method 1: Log in to the 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 using the VPC API. For details, see Querying Security Groups.

password

Yes

String

Database password.

The password can include 8 to 32 characters and contain uppercase letters, lowercase letters, digits, and the following special characters: ~!@#%^*-_=+?

Enter a strong password against security risks such as brute force cracking.

mode

Yes

String

Instance type. The value can be:

• Cluster, indicating that GeminiDB Cassandra supports the cluster type.
• Cluster, indicating that GeminiDB Influx supports the cluster type.
• Cluster, indicating that GeminiDB Redis supports the cluster type.
• Replication, indicating that GeminiDB Redis supports the primary/standby type.

flavor

Yes

Array of Flavor objects

Instance specifications.

For details about the specifications, see parameter values under flavors in Querying Instance Specifications.

configuration_id

No

String

Parameter template ID.

backup_strategy

No

BackupStrategy object

Advanced backup policy.

enterprise_project_id

No

String

Enterprise project ID.

• Do not transfer this parameter if EPS is not enabled.
• If EPS is enabled but this parameter is not transferred, the default enterprise project is used. For the enterprise project ID, see the id value in the enterprise_project field data structure table in section "Querying the Enterprise Project List" of the Enterprise Project Management Service API Reference.

ssl_option

No

String

Whether SSL is enabled.

The value can be:

• 0, indicating that SSL is disabled by default.
• 1, indicating that SSL is enabled by default.
• If this parameter is not transferred, SSL is disabled by default.

charge_info

No

ChargeInfo object

Billing mode, which includes yearly/monthly and pay-per-use. The default billing mode is pay-per-use.

dedicated_resource_id

No

String

Dedicated resource ID. This parameter can be delivered only after the dedicated resource pool is enabled.

restore_info

No

RestoreInfo object

Backup information. You can restore data from a specific backup or instance to a specific point in time during the backup retention period.

Only GeminiDB Cassandra and GeminiDB Influx allow you to restore data from a specific cluster instance to a specific point in time.

port

No

String

Port number for accessing the instance.

You can specify a port number for accessing GeminiDB Redis instances. The port number ranges from 1024 to 65535, excluding 2180, 2887, 3887, 6377, 6378, 6380, 8018, 8079, 8091, 8479, 8484, 8999, 9864, 9866, 9867, 12017, 12333, and 50069.

If you do not specify a port number, port 6379 is used by default when you create a GeminiDB Redis instance.

If you want to use this instance for dual-active DR, set the port to 8635.

type

Yes

String

Database type.

• GeminiDB Cassandra, GeminiDB Influx, and GeminiDB Redis instances are supported.
• If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
• If you set this parameter to influxdb, GeminiDB Influx instances will be created.
• If you set this parameter to redis, GeminiDB Redis instances will be created.

version

Yes

String

Database version. The value can be:

• 3.11: GeminiDB Cassandra instance 3.11
• 1.7: GeminiDB Influx instance 1.7
• 5.0: GeminiDB Redis instance 5.0

storage_engine

Yes

String

Storage engine.

• rocksDB, indicating that the GeminiDB Cassandra instance supports the RocksDB storage engine.
• rocksDB, indicating that the GeminiDB Influx instance supports the RocksDB storage engine.
• rocksDB, indicating that the GeminiDB Redis instance supports the RocksDB storage engine.

num

Yes

String

Number of nodes.

• Each GeminiDB Cassandra instance can run on 3 to 60 nodes.
• Each GeminiDB Influx cluster instance can run on 3 to 16 nodes.
• Each GeminiDB Redis instance can run on 2 to 36 nodes.

size

Yes

String

Storage space. It must be an integer, in GB.

• For details about GeminiDB Cassandra instances, see Instance Specifications.
• For details about GeminiDB Influx instances, see Instance Specifications.
• For details about GeminiDB Redis instances, see Instance Specifications.

storage

Yes

String

Disk type.

If you set this parameter to ULTRAHIGH, SSD disks are used.

spec_code

Yes

String

Resource specification code.

For the code, see the value of response parameter spec_code in Querying Instance Specifications.

start_time

Yes

String

Backup time window. Automated backup will be triggered during the backup time window.

The value cannot be empty. It must be the UTC time in the hh:mm-HH:MM 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, 15, 30, or 45.
• If this parameter is not transferred, the default backup time window is from 00:00 to 01:00.
• Example value: 23:00–00:00

keep_days

No

String

Backup retention days.

The value ranges from 0 to 35.

• If this parameter is set to 0, the automated backup policy is not set.
• If this parameter is not transferred, the automated backup policy is enabled by default. Backup files are stored for 7 days by default.

charge_mode

Yes

String

Billing mode.

Values:

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

period_type

No

String

Subscription period type.

Values:

• month: indicates that the subscription unit is month.
• year: indicates that the subscription unit is year.

period_num

No

String

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

Values:

• If period_type is set to month, the parameter value ranges from 1 to 9.
• If 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 instances. The renewal period is the same as the original period, and the order will be automatically paid during the renewal. The value can be:

• true, indicating that the subscription is automatically renewed.
• false, indicating that the subscription is not automatically renewed. The default value is false.

is_auto_pay

No

String

Payment method. When you create a yearly/monthly instance, you can specify whether the order is automatically paid from your account. This parameter does not affect the payment mode of automatic renewal. The value can be:

• true, indicating that the order is automatically paid from your account.
• false, indicating that the order needs to be manually paid from your account. This payment method is used by default.

backup_id

No

String

Backup file ID.

This parameter cannot be left blank when you create an instance to restore data using a specific backup.

source_instance_id

No

String

ID of the specified instance that backup data is restored to.

This parameter cannot be left blank when you restore data at a specific time point from a specific instance to a new instance.

restore_time

No

Long

Time point that backup data is restored to.

This parameter cannot be left blank when you restore data at a specific point in time from a specific instance to a new instance. The value is a 13-digit number (in milliseconds, UTC time).

id

String

Instance ID.

name

String

Instance name. This parameter is the same as the corresponding request parameter.

datastore

Datastore object

Database information. This parameter is the same as the corresponding request parameter.

created

String

Creation time, which is in the yyyy-mm-dd hh:mm:ss format.

status

String

Instance status. The value is creating.

region

String

Region ID. This parameter is the same as the corresponding request parameter.

availability_zone

String

AZ ID. This parameter is the same as the corresponding request parameter.

vpc_id

String

VPC ID. This parameter is the same as the corresponding request parameter.

subnet_id

String

Subnet ID. This parameter is the same as the corresponding request parameter.

security_group_id

String

Security group ID. This parameter is the same as the corresponding request parameter.

mode

String

Instance type. This parameter is the same as the corresponding request parameter.

flavor

Array of Flavor objects

Instance specifications. This parameter is the same as the corresponding request parameter.

backup_strategy

BackupStrategy object

Advanced backup policy. This parameter is the same as the corresponding request parameter.

enterprise_project_id

String

Enterprise project ID. If you set this parameter to 0, the resource belongs to the default enterprise project.

ssl_option

String

Whether SSL is enabled. This parameter has the same effect as the corresponding request parameter.

job_id

String

ID of the workflow for creating an instance. This parameter is returned only when a pay-per-use instance is created.

order_id

String

ID of the order for creating an instance. This parameter is returned only when you create a yearly/monthly instance.

charge_info

ChargeInfo object

Billing mode, which includes yearly/monthly and pay-per-use. The default billing mode is pay-per-use.

dedicated_resource_id

String

Dedicated resource ID. This parameter is returned only when the DB instance belongs to a dedicated resource pool.

type

String

Database type.

• GeminiDB Cassandra, GeminiDB Influx, and GeminiDB Redis instances are supported.
• If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
• If you set this parameter to influxdb, GeminiDB Influx instances will be created.
• If you set this parameter to redis, GeminiDB Redis instances will be created.

version

String

Database version. The value can be:

• 3.11: GeminiDB Cassandra instance 3.11
• 1.7: GeminiDB Influx instance 1.7
• 5.0: GeminiDB Redis instance 5.0

storage_engine

String

Storage engine.

• rocksDB, indicating that the GeminiDB Cassandra instance supports the RocksDB storage engine.
• rocksDB, indicating that the GeminiDB Influx instance supports the RocksDB storage engine.
• rocksDB, indicating that the GeminiDB Redis instance supports the RocksDB storage engine.

num

String

Number of nodes.

• Each GeminiDB Cassandra instance can run on 3 to 60 nodes.
• Each GeminiDB Influx instance can run on 3 to 16 nodes.
• Each GeminiDB Redis instance can run on 2 to 36 nodes.

size

String

Storage space. It must be an integer, in GB.

• For details about GeminiDB Cassandra instances, see Instance Specifications.
• For details about GeminiDB Influx instances, see Instance Specifications.
• For details about GeminiDB Redis instances, see Instance Specifications.

storage

String

Disk type.

If you set this parameter to ULTRAHIGH, SSD disks are used.

spec_code

String

Resource specification code.

For the code, see the value of response parameter spec_code in Querying Instance Specifications.

start_time

String

Backup time window. Automated backup will be triggered during the backup time window.

The value cannot be empty. It must be the UTC time in the hh:mm-HH:MM 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, 15, 30, or 45.
• If this parameter is not transferred, the default backup time window is from 00:00 to 01:00.
• Example value: 23:00–00:00

keep_days

String

Backup retention days.

The value ranges from 0 to 35.

• If this parameter is set to 0, the automated backup policy is not set.
• If this parameter is not transferred, the automated backup policy is enabled by default. Backup files are stored for 7 days by default.

charge_mode

String

Billing mode.

Values:

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

period_type

String

Subscription period type.

Values:

• month: indicates that the subscription unit is month.
• year: indicates that the subscription unit is year.

period_num

String

Subscription time period. This parameter is available and mandatory only when charge_mode is set to prePaid.

Values:

• If period_type is set to month, the parameter value ranges from 1 to 9.
• If 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 instances. The renewal period is the same as the original period, and the order will be automatically paid during the renewal. The value can be:

• true, indicating that the subscription is automatically renewed.
• false, indicating that the subscription is not automatically renewed. The default value is false.

is_auto_pay

String

Payment method. When you create a yearly/monthly instance, you can specify whether the order is automatically paid from your account. This parameter does not affect the payment mode of automatic renewal. The value can be:

• true, indicating that the order is automatically paid from your account.
• false, indicating that the order needs to be manually paid from your account. This payment method is used by default.