ApsaraDB RDS:CreateReadOnlyDBInstance

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 token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

The region ID. The read-only instance and the primary instance must reside in the same region. You can call the DescribeRegions operation to query the most recent region list.

The zone ID. You can call the DescribeRegions operation to query the zone ID.

• If you use the single-zone deployment method, set this parameter to the ID of one zone. Example: cn-hangzhou-b.
• If you use the multi-zone deployment method, set this parameter to the IDs of multiple zones and separate the IDs with colons (:). Example: cn-hangzhou-b:cn-hangzhou-c.
• The number of zone IDs that you specify must be less than or equal to the number of nodes created for the read-only instance. If you create a read-only instance that runs RDS Basic Edition, only one node is provisioned. If you create a read-only instance that runs RDS High-availability Edition, one primary node and one secondary node are provisioned.

The primary instance ID. You can call the DescribeDBInstances operation to query the instance ID.

The instance type of the read-only instance. For more information, see Read-only instance types. We recommend that you specify an instance type whose specifications are higher than or equal to the specifications of the instance type of the primary instance. If the specifications of the read-only instance are lower than the specifications of the primary instance, the read-only instance may encounter issues such as high latency and heavy load.

The storage capacity of the read-only instance. The storage capacity of the read-only instance must be greater than or equal to that of the primary instance. For more information, see the Storage capacity column in Read-only instance types. This value must be a multiple of 5. Unit: GB.

The version of the database engine. The read-only instance and the primary instance must run the same major engine version.

• If the read-only instance runs MySQL, set this parameter to 5.6, 5.7, or 8.0.
• If the read-only instance runs MySQL, set this parameter to 2017_ent, 2019_ent, or 2022_ent.
• If the read-only instance runs PostgreSQL, set this parameter to 10.0, 11.0, 12.0, 13.0, 14.0, or 15.0.

The billing method of the read-only instance. Valid values:

• Postpaid: pay-as-you-go
• Prepaid: subscription

The description of the read-only instance. The description must be 2 to 256 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The value must start with a letter

The network type of the read-only instance. Valid values:

• VPC
• Classic

Default value: VPC. If you set this parameter to VPC, you must also specify the VPCId and VSwitchId parameters.

The virtual private cloud (VPC) ID of the read-only instance. If you leave the InstanceNetworkType parameter empty or set it to VPC, you must also specify this parameter.

The vSwitch ID of the read-only instance. If you leave the InstanceNetworkType parameter empty or set it to VPC, you must specify the VSwitchId parameter.

The private IP address of the read-only instance. The private IP address must be within the CIDR block that is supported by the specified vSwitch. The system assigns a private IP address to the read-only instance based on the values of the VPCId and VSwitchId parameters.

The ID of the resource group.

The RDS edition of the instance. Valid values:

• Basic: RDS Basic Edition
• HighAvailability (default): RDS High-availability Edition
• AlwaysOn: RDS Cluster Edition

The storage type of the instance. Valid values:

• local_ssd: local SSDs
• cloud_ssd: standard SSDs
• cloud_essd: enhanced SSDs (ESSDs) of performance level 1 (PL1)
• cloud_essd2: ESSDs of PL2
• cloud_essd3: ESSDs of PL3

The ID of the dedicated cluster to which the read-only instance belongs. This parameter is valid when you create the read-only instance in a dedicated cluster.

The ID of the host on which the primary instance resides. This parameter is valid when you create the read-only instance in a dedicated cluster.

A reserved parameter.

A reserved parameter.

A reserved parameter.

A reserved parameter.

The subscription duration of the read-only instance. Valid values:

• If you set the Period parameter to Year, the value of the UsedTime parameter ranges from 1 to 5.
• If you set the Period parameter to Month, the value of the UsedTime parameter ranges from 1 to 9.

The renewal cycle of the read-only instance. Valid values:

• Year
• Month

Specifies whether to enable the auto-renewal feature for the read-only instance. If you set the PayType parameter to Prepaid, you must also specify this parameter. Valid values:

• true: enables the feature.
• false: disables the feature.

Specifies whether to enable the release protection feature for the read-only instance. Valid values:

• true
• false (default)

The port that can be initialized when you create a read-only ApsaraDB RDS for MySQL instance.

Valid values: 1000 to 65534.

A reserved parameter. You do not need to specify this parameter.

An invalid parameter. You do not need to specify this parameter.

Specifies whether to automatically complete the payment. Valid values:

1. true: automatically completes the payment. Make sure that your account balance is sufficient.
2. false: does not automatically complete the payment. An unpaid order is generated.

Specifies whether to automatically create database proxies. Valid values:

• true: automatically creates database proxies. By default, general-purpose database proxies are created.
• false: does not automatically create database proxies.

A reserved parameter.