Creates a read-only instance for an instance.
Operation Description
Before you call this operation, take note of the following limits:
The primary instance cannot belong to a dedicated cluster and must run one of the following database engine versions and RDS editions:
- MySQL 8.0 on RDS High-availability Edition or RDS Enterprise Edition.
- MySQL 5.7 on RDS High-availability Edition or RDS Enterprise Edition.
- MySQL 5.6.
- SQL Server 2017 on RDS Cluster Edition.
- PostgreSQL 10, PostgreSQL 11, PostgreSQL 12, PostgreSQL 13, PostgreSQL 14, or PostgreSQL 15 on RDS High-availability Edition. If the primary instance runs PostgreSQL 10, the instance must use local disks and must be a dedicated instance that provides at least 8 cores and 32 GB of memory.
If the primary instance runs MySQL, you can create up to 10 read-only instances.
If the primary instance runs SQL Server, you can create up to seven read-only instances.
If the primary instance runs PostgreSQL with local disks, you can create up to five read-only instances. If the primary instance runs PostgreSQL with cloud disks, you can create up to 32 read-only instances.
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:CreateReadOnlyDBInstance | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientToken | string | No | 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. | ETnLKlblzczshOTUbOC**** |
RegionId | string | Yes | The region ID of the read-only instance. 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. | cn-hangzhou |
ZoneId | string | Yes | The zone ID of the read-only instance. You can call the DescribeRegions operation to query the most recent zone list. | cn-hangzhou-b |
DBInstanceId | string | Yes | The ID of the primary instance. | rm-uf6wjk5**** |
DBInstanceClass | string | Yes | The instance type of the read-only instance. For more information, see Read-only ApsaraDB RDS 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. | rds.mys2.small |
DBInstanceStorage | integer | Yes | The storage capacity of the read-only instance. For more information, see the Storage space column in Read-only instance types. This value must be a multiple of 5 GB. Unit: GB. | 20 |
EngineVersion | string | Yes | The major engine version of the read-only instance. The read-only instance and the primary instance must run the same major engine version.
| 5.6 |
PayType | string | Yes | The billing method of the read-only instance. Valid values:
| Postpaid |
DBInstanceDescription | string | No | 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 NoteThe value cannot start with http:// or https:// . | Test read-only instance |
InstanceNetworkType | string | No | The network type of the read-only instance. Valid values:
Default value: VPC. If you set this parameter to VPC, you must also specify the VPCId and VSwitchId parameters. NoteThe network type of the read-only instance can be different from the network type of the primary instance. | Classic |
VPCId | string | No | 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. Note | vpc-uf6f7l4fg90**** |
VSwitchId | string | No | 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. | vsw-uf6adz52c2p**** |
PrivateIpAddress | string | No | 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. | 172.16.XX.XX |
ResourceGroupId | string | No | The ID of the resource group. | rg-acfmy**** |
Category | string | No | The RDS edition of the read-only instance. Valid values:
NoteIf the primary instance runs PostgreSQL with cloud disks, you must set this parameter to Basic. | HighAvailability |
DBInstanceStorageType | string | No | The storage type of the read-only instance. Valid values:
Note | local_ssd |
DedicatedHostGroupId | string | No | 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. | dhg-4n**** |
TargetDedicatedHostIdForMaster | string | No | 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. | i-bp**** |
GdnInstanceName | string | No | A reserved parameter. | None |
TddlBizType | string | No | A reserved parameter. | None |
TddlRegionConfig | string | No | A reserved parameter. | None |
InstructionSetArch | string | No | A reserved parameter. | None |
UsedTime | string | No | The subscription duration of the read-only instance. Valid values:
NoteIf you set the PayType parameter to Prepaid, you must specify the UsedTime parameter. | 1 |
Period | string | No | The renewal cycle of the read-only instance. Valid values:
| Month |
AutoRenew | string | No | 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:
Note | true |
DeletionProtection | boolean | No | Specifies whether to enable the release protection feature for the read-only instance. Valid values:
NoteThis feature can be enabled only when you set the PayType parameter to Postpaid. | true |
Response parameters
Examples
Sample success responses
JSON
format
{
"DBInstanceId": "rr-uf6wjk5****",
"RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
"Port": "3306",
"ConnectionString": "rr-****.mysql.rds.aliyuncs.com",
"OrderId": "10078937****"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidEngineVersion.Malformed | The specified parameter EngineVersion is not valid. | - |
400 | InvalidNetworkTypeClassicWhenCloudStorage | The Specified InstanceNetworkType value Classic is not valid when choose cloud storage type. | - |
400 | InvalidSecurityIPList.Malformed | The specified parameter SecurityIPList is not valid. | - |
400 | InvalidSecurityIPList.Duplicate | The Security IP address is not in the available range or occupied. | The IP address is invalid. Specify a valid IP address. |
400 | InvalidParameter | The specified parameter dbInstanceId is not valid. | - |
400 | OperationDenied | VPC IP is in use, please check. | The operation failed. The VPC IP address has been used. |
400 | InvalidZoneId.NotSupported | The Specified vpc Zone not supported. | VPC-hosted RDS instances cannot be created in the zone. Specify a different zone. |
400 | InvalidAvZone.NotSupport | Specified availableArea multiZone does not support in RDS. | - |
400 | CDDC.AvailableHostsNotEnoughInZone | Not enough available hosts are in the target zone. | - |
400 | InvalidReadEngineVersionPattern | The engine versions of the primary instance and the read-only instance do not match. | - |
403 | OperationDenied.PrimaryDBInstanceStatus | The operation is not permitted due to status of primary instance. | The operation failed. The RDS instance is deployed in a dedicated cluster and is not running. |
403 | InvalidReadStorageTypePattern | The storage type of the primary instance and the read-only instance do not match. | - |
404 | IncorrectDBInstanceConnType | Current DB instance conn type does not support this operation. | The operation is not supported for the connection type of the RDS instance. |
500 | CannotDecreaseEssdPerfLevel | cannot decrease cloud essd performance level. | The storage type change failed the verification check. The storage type of an RDS instance that runs SQL Server with standard SSDs or ESSDs cannot be changed to local SSDs. |
500 | InvalidEssdStorageSize | invalid cloud essd storage size. | The storage size of cloud disks is invalid. Check the storage size. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-04-20 | The error codes of the API operation change. | |||||||||||||||
| ||||||||||||||||
2023-04-07 | The error codes of the API operation change. | |||||||||||||||
| ||||||||||||||||
2022-09-01 | The error codes of the API operation change. | |||||||||||||||
| ||||||||||||||||
2021-09-13 | The error codes of the API operation change.,The input parameters of the API operation change. | |||||||||||||||
|