ApsaraDB for MongoDB:CreateDBInstance

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

The zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list.

The database engine of the instance. Set the value to MongoDB.

The database engine version of the instance.

• 6.0
• 5.0
• 4.4
• 4.2
• 4.0

The instance type. You can also call the DescribeAvailableResource operation to view instance types.

The storage capacity of the instance. Unit: GB.

The values that can be specified for this parameter are subject to the instance types. For more information, see Replica set instance types.

The name of the instance. Valid values:

• The name must start with a letter.
• The name can contain digits, letters, underscores (_), and hyphens (-).
• The name must be 2 to 256 characters in length.

The IP addresses in an IP address whitelist. Separate multiple IP addresses with commas (,). Each IP address in the IP address whitelist must be unique. The following types of IP addresses are supported:

• 0.0.0.0/0
• IP addresses, such as 10.23.12.24.
• Classless Inter-Domain Routing (CIDR) blocks, such as 10.23.12.0/24. In this case, /24 indicates that the prefix of each IP address is 24-bit long. You can replace 24 with a value within the range of 1 to 32.

• A maximum of 1,000 IP addresses and CIDR blocks can be configured for each instance.

• If you enter 0.0.0.0/0, all IP addresses can access the instance. This may introduce security risks to the instance.

The password of the root account. The password must meet the following requirements:

• The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
• These special characters include ! # $ % ^ & * ( ) _ + - =
• The password is 8 to 32 characters in length.

The billing method of the instance. Valid values:

• PostPaid: pay-as-you-go
• PrePaid: subscription

The subscription period of the instance. Unit: months.

Valid values: 1 to 9, 12, 24, 36, and 60.

The network type of the instance. Valid values:

VPC

The VPC ID of the instance.

The vSwitch ID of the instance.

The ID of the source instance.

The ID of the backup set. You can call the DescribeBackups operation to query the backup set ID.

The point in time to clone the instance, which must be within seven days. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

The business information. This is an additional parameter.

Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values:

• true
• false

The name of the database.

The coupon code. Default value: youhuiquan_promotion_option_id_for_blank.

The storage engine used by the instance. Set the value to WiredTiger.

• If you call this operation to clone an instance or restore an instance from the recycle bin, set the value to the engine of the source instance.

• For more information about the limits on database versions and storage engines, see MongoDB versions and storage engines.

The number of nodes in the replica set instance. Default value: 3. Valid values:

• 3
• 5
• 7

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

The ID of the resource group to which the instances you want to query belong.

The ID of the dedicated cluster to which the instance belongs.

The storage type of the instance. Valid values:

• cloud_essd1 :ESSD PL1.
• cloud_essd2: ESSD PL2.
• cloud_essd3: ESSD PL3.
• local_ssd: local SSD

The zone where the secondary node is deployed for multi-zone deployment. Valid values:

• cn-hangzhou-g: Hangzhou Zone G
• cn-hangzhou-h: Hangzhou Zone H
• cn-hangzhou-i: Hangzhou Zone I
• cn-hongkong-b: Hongkong Zone B.
• cn-hongkong-c: Hongkong Zone C
• cn-hongkong-d: Hongkong Zone D
• cn-wulanchabu-a: Ulanqab Zone A
• cn-wulanchabu-b: Ulanqab Zone B
• cn-wulanchabu-c: Ulanqab Zone C
• ap-southeast-1a: Singapore Zone A
• ap-southeast-1b: Singapore Zone B
• ap-southeast-1c: Singapore Zone C
• ap-southeast-5a: Jakarta Zone A
• ap-southeast-5b: Jakarta Zone B
• ap-southeast-5c: Jakarta Zone C
• eu-central-1a: Frankfurt Zone A
• eu-central-1b: Frankfurt Zone B
• eu-central-1c: Frankfurt Zone C

• This parameter is valid and required when the EngineVersion parameter is set to 4.4 or 5.0.

• The value of this parameter cannot be the same as the value of the ZoneId or HiddenZoneId parameter.

The zone where the hidden node is deployed for multi-zone deployment. Valid values:

• cn-hangzhou-g: Hangzhou Zone G
• cn-hangzhou-h: Hangzhou Zone H
• cn-hangzhou-i: Hangzhou Zone I
• cn-hongkong-b: Hongkong Zone B.
• cn-hongkong-c: Hongkong Zone C
• cn-hongkong-d: Hongkong Zone D
• cn-wulanchabu-a: Ulanqab Zone A
• cn-wulanchabu-b: Ulanqab Zone B
• cn-wulanchabu-c: Ulanqab Zone C
• ap-southeast-1a: Singapore Zone A
• ap-southeast-1b: Singapore Zone B
• ap-southeast-1c: Singapore Zone C
• ap-southeast-5a: Jakarta Zone A
• ap-southeast-5b: Jakarta Zone B
• ap-southeast-5c: Jakarta Zone C
• eu-central-1a: Frankfurt Zone A
• eu-central-1b: Frankfurt Zone B
• eu-central-1c: Frankfurt Zone C

• This parameter is valid and required when the EngineVersion parameter is set to 4.4 or 5.0.

• The value of this parameter cannot be the same as the value of the ZoneId or SecondaryZoneId parameter.