Creating an Instance

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A

name

Yes

String

Explanation:

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

Constraints:

The name can be 4 to 64 bytes in length and must start with a letter. Names are case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

Values:

N/A

Default value:

N/A

datastore

Yes

Datastore object

Explanation:

Database information

Constraints:

N/A

Values:

N/A

Default value:

N/A

region

Yes

String

Explanation:

Region ID

Constraints:

The value cannot be empty. For details, see Regions and Endpoints.

Values:

N/A

Default value:

N/A

availability_zone

Yes

String

Explanation:

AZ ID

Constraints:

N/A

Values:

See az_status returned in Querying Instance Specifications. Three AZs can be created. You need to separate AZ IDs using commas (,).

Default value:

N/A

vpc_id

Yes

String

Explanation:

VPC ID

Constraints:

N/A

Values:

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

Default value:

N/A

subnet_id

Yes

String

Explanation:

Subnet ID

Constraints:

N/A

Values:

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: Query the subnet ID using the VPC API. For details, see Querying Subnets.

Default value:

N/A

security_group_id

Yes

String

Explanation:

Security group ID

Constraints:

N/A

Values:

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

Default value:

N/A

password

Yes

String

Explanation:

Database password

Constraints:

N/A

Values:

The password can contain 8 to 32 characters, including uppercase letters, lowercase letters, digits, and special characters ~!@#%^*-_=+? The password of a GeminiDB Redis instance can contain at least two types of the following characters: uppercase letters, lowercase letters, digits, and special characters ~!@#$%^&*()-_=+?

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

Default value:

N/A

mode

Yes

String

Explanation:

Instance type

Constraints:

N/A

Values:

• Cluster: GeminiDB Cassandra cluster instance with classic storage

• CloudNativeCluster: GeminiDB Cassandra cluster instance with cloud native storage

• ReplicaSet: GeminiDB Mongo instance 4.0 in a replica set

• Cluster: GeminiDB Influx cluster instance which classic storage

• CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage

• EnhancedCluster: GeminiDB Influx cluster (performance-enhanced) instance with classic storage
• InfluxdbSingle: single-node GeminiDB Influx instance
• Cluster: proxy cluster GeminiDB Redis instance with classic storage

• CloudNativeCluster: GeminiDB Redis cluster instance with cloud native storage

• RedisCluster: Redis Cluster GeminiDB Redis instance with classic storage. For details about Redis Cluster instances, see Creating an Instance.
• Replication: primary/standby GeminiDB Redis instance with classic storage

Default value:

N/A

product_type

No

String

Explanation:

Product type

Constraints:

This parameter is mandatory when you create a GeminiDB Redis instance with cloud native storage.

Values:

• Capacity

Default value:

N/A

flavor

Yes

Array of Flavor objects

Explanation:

Instance specifications

Constraints:

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

Values:

N/A

Default value:

N/A

configuration_id

No

String

Explanation:

Parameter template ID

Constraints:

N/A

Values:

N/A

Default value:

N/A

backup_strategy

No

BackupStrategy object

Explanation:

Advanced backup policy

Constraints:

N/A

Values:

N/A

Default value:

N/A

enterprise_project_id

No

String

Explanation:

Enterprise project ID

Constraints:

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

Values:

N/A

Default value:

N/A

ssl_option

No

String

Explanation:

Whether SSL is enabled

Constraints:

N/A

Values:

• 0, indicating that SSL is disabled by default.
• 1, indicating that SSL is enabled by default.

Default value:

If this parameter is not transferred, SSL is disabled by default.

charge_info

No

ChargeInfo object

Explanation:

Billing information

Constraints:

N/A

Values:

Yearly/Monthly and Pay-per-use

Default value:

Pay-per-use

dedicated_resource_id

No

String

Explanation:

Dedicated resource ID

Constraints:

This parameter is available only after a dedicated resource pool is enabled.

Values:

N/A

Default value:

N/A

restore_info

No

RestoreInfo object

Explanation:

Backup information

Constraints:

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.

Values:

N/A

Default value:

N/A

port

No

String

Explanation:

Database port

Constraints:

Currently, only GeminiDB Redis instances support user-defined ports.

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.

Values:

The value ranges from 1024 to 65535. The disabled ports are 2180, 2887, 3887, 6377, 6378, 6380, 8018, 8079, 8091, 8479, 8484, 8999, 9864, 9866, 9867, 12017, 12333 and 50069.

Default value:

6379

availability_zone_detail

No

object

Explanation:

Multi-AZ details of primary/standby instances

Constraints:

Currently, only GeminiDB Redis instances are supported.

The system ignores this parameter if single-AZ deployment is selected. For details, see Table 9.

Values:

N/A

Default value:

N/A

type

Yes

String

Explanation:

Database type

Constraints:

• GeminiDB Cassandra, GeminiDB Mongo, GeminiDB Influx, and GeminiDB Redis instances are supported.

Values:

• If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
• If you set this parameter to mongodb, GeminiDB Mongo 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.
• If you set this parameter to dynamodb, GeminiDB DynamoDB-Compatible instances will be created.
• If you set this parameter to hbase, GeminiDB HBase instances will be created.

Default value:

N/A

version

Yes

String

Explanation:

Database version

Constraints:

• 3.11: GeminiDB Cassandra instance 3.11
• 4.0: GeminiDB Mongo instance 4.0
• 1.8: GeminiDB Influx cluster instance 1.8 with classic storage
• 1.8: GeminiDB Influx cluster (performance-enhanced) instance 1.8 with classic storage
• 1.7: GeminiDB Influx cluster (performance-enhanced) instance 1.7 with cloud native storage
• 5.0: GeminiDB Redis instance 5.0
• For a GeminiDB DynamoDB-Compatible instance, the value is null.
• For a GeminiDB HBase instance, the value is null.

Values:

N/A

Default value:

N/A

storage_engine

Yes

String

Explanation:

Storage engine

Constraints:

N/A

Values:

• rocksDB: A GeminiDB Cassandra instance supports RocksDB.
• rocksDB: A GeminiDB Mongo instance supports RocksDB.
• rocksDB: A GeminiDB Influx instance supports RocksDB.
• rocksDB: A GeminiDB Redis instance supports RocksDB.

Default value:

N/A

num

Yes

String

Explanation:

Node quantity

Constraints:

N/A

Values:

• Each GeminiDB Cassandra instance can contain 3 to 60 nodes.
• Each GeminiDB Mongo replica set 4.0 can contain 3 nodes.
• Each GeminiDB Influx cluster instance can contain 3 to 16 nodes.
• Each GeminiDB Influx single-node instance can contain 1 node.
• Each GeminiDB Redis instance can contain 3 to 12 nodes.

Default value:

N/A

size

Yes

String

Explanation:

Disk size, which must be an integer, in GB

Constraints:

For GeminiDB Cassandra, GeminiDB Mongo, and GeminiDB Influx instances, the minimum storage space is 100 GB, and the maximum limit depends on instance specifications. The maximum and minimum storage space of a GeminiDB Redis instance depends on node quantity and specifications of the instance.

Values:

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

Default value:

N/A

storage

Yes

String

Explanation:

Disk type

Constraints:

N/A

Values:

ULTRAHIGH: SSD

Default value:

N/A

spec_code

Yes

String

Explanation:

Resource specification code

Constraints:

N/A

Values:

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

Default value:

N/A

start_time

Yes

String

Explanation:

Backup time window. Automated backups will be created during the backup time window.

Constraints:

The value cannot be empty. It must be a valid value in the hh:mm-HH:MM format. The current time is specified in UTC.

• 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 specified, the default backup time period is 00:00–01:00.
• Example value: 23:00–00:00

Values:

N/A

Default value:

00:00–01:00

keep_days

No

String

Explanation:

Backup retention days

Constraints:

N/A

Values:

0–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.

Default value:

7

charge_mode

Yes

String

Explanation:

Billing mode

Constraints:

N/A

Values:

• prePaid: yearly/monthly
• postPaid: pay-per-use

Default value:

N/A

period_type

No

String

Explanation:

Subscription type

Constraints:

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

Values:

• month: monthly
• year: yearly

Default value:

N/A

period_num

No

String

Explanation:

Subscription period

Constraints:

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

Values:

• If period_type is set to month, the value ranges from 1 to 9.
• If period_type is set to year, the value ranges from 1 to 3.

Default value:

N/A

is_auto_renew

No

String

Explanation:

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.

Constraints:

N/A

Values:

• true: The subscription is automatically renewed.
• false: The subscription is not automatically renewed. The default value is false.

Default value:

false

is_auto_pay

No

String

Explanation:

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

Constraints:

N/A

Values:

• true: An order is automatically paid from the account.
• false: An order needs to be manually paid. This payment method is used by default.

Default value:

false

backup_id

No

String

Explanation:

Full backup file ID.

Constraints:

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

Values:

N/A

Default value:

N/A

source_instance_id

No

String

Explanation:

ID of the specified instance for data restoration

Constraints:

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

Values:

N/A

Default value:

N/A

restore_time

No

Long

Explanation:

Time point that backup data is restored to

Constraints:

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

Values:

The value is a 13-digit number (in milliseconds, UTC time). You can query the value by referring to Querying the Time Window When a Backup Can Be Restored.

Default value:

N/A

primary_availability_zone

Yes

String

Explanation:

Primary AZ, which must be a single AZ and different from the standby AZ

Constraints:

N/A

Values:

N/A

Default value:

N/A

secondary_availability_zone

Yes

String

Explanation:

Standby AZ, which must be a single AZ and be different from the primary AZ

Constraints:

N/A

Values:

N/A

Default value:

N/A

id

String

Explanation:

Instance ID

Values:

N/A

name

String

Explanation:

Database information, which is the same as the request parameter

Values:

N/A

datastore

Datastore object

Explanation:

Instance name, which is the same as the request parameter

Values:

N/A

created

String

Explanation:

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

Values:

N/A

status

String

Explanation:

Instance status

Values:

creating

region

String

Explanation:

Region ID, which is the same as the request parameter

Values:

N/A

availability_zone

String

Explanation:

AZ ID, which is the same as the request parameter

Values:

N/A

vpc_id

String

Explanation:

VPC ID, which is the same as the request parameter

Values:

N/A

subnet_id

String

Explanation:

Subnet ID, which is the same as the request parameter

Values:

N/A

security_group_id

String

Explanation:

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

Values:

N/A

mode

String

Explanation:

Instance type, which is the same as the request parameter

Values:

N/A

flavor

Array of Flavor objects

Explanation:

Instance flavor, which is the same as the request parameter

Values:

N/A

backup_strategy

BackupStrategy object

Explanation:

Advanced backup policy, which is the same as the request parameter

Values:

N/A

enterprise_project_id

String

Explanation:

Enterprise project ID. 0 indicates the default enterprise project.

Values:

N/A

ssl_option

String

Explanation:

Whether SSL is enabled. This parameter functions the same as the request parameter.

Values:

N/A

job_id

String

Explanation:

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

Values:

N/A

order_id

String

Explanation:

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

Values:

N/A

charge_info

ChargeInfo object

Explanation:

Billing mode, which can be yearly/monthly or pay-per-use (default). The value is the same as that of the request parameter.

Values:

N/A

dedicated_resource_id

String

Explanation:

Dedicated resource ID. This field is returned only for instances created on dedicated resources.

Values:

N/A

type

String

Explanation:

Database type

Values:

• GeminiDB Cassandra, GeminiDB Mongo, 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 mongodb, GeminiDB Mongo 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.
• If you set this parameter to dynamodb, GeminiDB DynamoDB-Compatible instances will be created.
• If you set this parameter to hbase, GeminiDB HBase instances will be created.

version

String

Explanation:

Database version

Values:

• 3.11: GeminiDB Cassandra instance 3.11
• 4.0: GeminiDB Mongo instance 4.0
• 1.8: GeminiDB Influx instance 1.8 with classic storage
• 1.7: GeminiDB Influx cluster (performance-enhanced) instance 1.7 with cloud native storage
• 1.8: GeminiDB Influx cluster (performance-enhanced) instance 1.8 with classic storage
• 5.0, indicating that GeminiDB Redis 5.0 is supported.
• For a GeminiDB DynamoDB-Compatible instance, the value is null.
• For a GeminiDB HBase instance, the value is null.

storage_engine

String

Explanation:

Storage engine

Values:

• rocksDB: A GeminiDB Cassandra instance supports RocksDB.
• rocksDB: A GeminiDB Mongo instance supports RocksDB.
• rocksDB: A GeminiDB Influx instance supports RocksDB.
• rocksDB: A GeminiDB Redis instance supports RocksDB.

num

String

Explanation:

Node quantity

Values:

• Each GeminiDB Cassandra instance can contain 3 to 60 nodes.
• Each GeminiDB Mongo replica set 4.0 can contain 3 nodes.
• Each GeminiDB Influx instance can contain 3 to 16 nodes.
• Each GeminiDB Redis instance can contain 3 to 12 nodes.

size

String

Explanation:

Disk size, which must be an integer, in GB

For GeminiDB Cassandra, GeminiDB Mongo, and GeminiDB Influx instances, the minimum storage space is 100 GB, and the maximum limit depends on instance specifications. The maximum and minimum storage space of a GeminiDB Redis instance depends on node quantity and specifications of the instance.

Values:

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

storage

String

Explanation:

Disk type

Values:

ULTRAHIGH: SSD

spec_code

String

Explanation:

Resource specification code.

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

Values:

N/A

start_time

String

Explanation:

Backup time window. Automated backups will be created during the backup time window.

Values:

The value cannot be empty. It must be a valid value in the hh:mm-HH:MM format. The current time is specified in UTC.

• 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 or 30.
• If this parameter is not specified, the default backup time period is 00:00–01:00.
• Example value: 23:00–00:00

keep_days

String

Explanation:

Backup retention days

Values:

0–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

Explanation:

Billing mode

Values:

• prePaid: yearly/monthly
• postPaid: pay-per-use

period_type

String

Explanation:

Subscription type

Values:

• month: monthly
• year: yearly

period_num

String

Explanation:

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

Values:

• If period_type is set to month, the value ranges from 1 to 9.
• If period_type is set to year, the value ranges from 1 to 3.

is_auto_renew

String

Explanation:

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.

Values:

• true: The subscription is automatically renewed.
• false: The subscription is not automatically renewed. The default value is false.

is_auto_pay

String

Explanation:

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

Values:

• true: An order is automatically paid from the account.
• false: An order needs to be manually paid. This payment method is used by default.