All Products
Search

This Product

    ApsaraDB RDS:CreateReadOnlyDBInstance

    Document Center

    ApsaraDB RDS:CreateReadOnlyDBInstance

    Last Updated:May 29, 2023

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:CreateReadOnlyDBInstanceWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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****
    RegionIdstringYes

    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
    ZoneIdstringYes

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

    		cn-hangzhou-b
    DBInstanceIdstringYes

    The ID of the primary instance.

    		rm-uf6wjk5****
    DBInstanceClassstringYes

    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
    DBInstanceStorageintegerYes

    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
    EngineVersionstringYes

    The major engine version of the read-only instance. 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 SQL Server, set this parameter to 2017_ent or 2019_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
    		5.6
    PayTypestringYes

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

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

    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
    InstanceNetworkTypestringNo

    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.

    NoteThe network type of the read-only instance can be different from the network type of the primary instance.
    		Classic
    VPCIdstringNo

    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
  • If the primary instance uses local disks, the read-only instance and the primary instance can belong to the same VPC or different VPCs.
  • If the primary instance uses cloud disks, the read-only instance and the primary instance must belong to the same VPC.
    		• vpc-uf6f7l4fg90****
    VSwitchIdstringNo

    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****
    PrivateIpAddressstringNo

    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
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-acfmy****
    CategorystringNo

    The RDS edition of the read-only instance. Valid values:

    • Basic: RDS Basic Edition.
    • HighAvailability: RDS High-availability Edition. This is the default value.
    • AlwaysOn: RDS Cluster Edition.
    NoteIf the primary instance runs PostgreSQL with cloud disks, you must set this parameter to Basic.
    		HighAvailability
    DBInstanceStorageTypestringNo

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

    • local_ssd: local SSD
    • cloud_ssd: standard SSD
    • cloud_essd: enhanced SSD (ESSD) of performance level 1 (PL1)
    • cloud_essd2: ESSD of PL2
    • cloud_essd3: ESSD of PL3
    Note
  • If the primary instance runs MySQL with local disks, you must set this parameter to local_ssd. If the primary instance runs MySQL with cloud disks, you must set this parameter to cloud_ssd, cloud_essd, cloud_essd2, or cloud_essd3.
  • If the primary instance runs SQL Server, you must set this parameter to cloud_ssd, cloud_essd, cloud_essd2, or cloud_essd3.
    		• local_ssd
    DedicatedHostGroupIdstringNo

    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****
    TargetDedicatedHostIdForMasterstringNo

    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****
    GdnInstanceNamestringNo

    A reserved parameter.

    		None
    TddlBizTypestringNo

    A reserved parameter.

    		None
    TddlRegionConfigstringNo

    A reserved parameter.

    		None
    InstructionSetArchstringNo

    A reserved parameter.

    		None
    UsedTimestringNo

    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.
    NoteIf you set the PayType parameter to Prepaid, you must specify the UsedTime parameter.
    		1
    PeriodstringNo

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

    • Year
    • Month
    		Month
    AutoRenewstringNo

    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.
    Note
  • If you set the Period parameter to Month, the auto-renewal cycle is one month.
  • If you set the Period parameter to Year, the auto-renewal cycle is one year.
    		• true
    DeletionProtectionbooleanNo

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

    • true: enables the feature.
    • false: disables the feature. This is the default value.
    NoteThis feature can be enabled only when you set the PayType parameter to Postpaid.
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object
    DBInstanceIdstring

    The ID of the read-only instance.

    		rr-uf6wjk5****
    RequestIdstring

    The ID of the request.

    		1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC
    Portstring

    The internal port number that is used to connect to the read-only instance.

    		3306
    ConnectionStringstring

    The internal endpoint that is used to connect to the read-only instance.

    		rr-****.mysql.rds.aliyuncs.com
    OrderIdstring

    The ID of the order.

    		10078937****

    Examples

    Sample success responses

    JSONformat

    {
  "DBInstanceId": "rr-uf6wjk5****",
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
  "Port": "3306",
  "ConnectionString": "rr-****.mysql.rds.aliyuncs.com",
  "OrderId": "10078937****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidEngineVersion.MalformedThe specified parameter EngineVersion is not valid.-
    400InvalidNetworkTypeClassicWhenCloudStorageThe Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.-
    400InvalidSecurityIPList.MalformedThe specified parameter SecurityIPList is not valid.-
    400InvalidSecurityIPList.DuplicateThe Security IP address is not in the available range or occupied.The IP address is invalid. Specify a valid IP address.
    400InvalidParameterThe specified parameter dbInstanceId is not valid.-
    400OperationDeniedVPC IP is in use, please check.The operation failed. The VPC IP address has been used.
    400InvalidZoneId.NotSupportedThe Specified vpc Zone not supported.VPC-hosted RDS instances cannot be created in the zone. Specify a different zone.
    400InvalidAvZone.NotSupportSpecified availableArea multiZone does not support in RDS.-
    400CDDC.AvailableHostsNotEnoughInZoneNot enough available hosts are in the target zone.-
    400InvalidReadEngineVersionPatternThe engine versions of the primary instance and the read-only instance do not match.-
    403OperationDenied.PrimaryDBInstanceStatusThe 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.
    403InvalidReadStorageTypePatternThe storage type of the primary instance and the read-only instance do not match.-
    404IncorrectDBInstanceConnTypeCurrent DB instance conn type does not support this operation.The operation is not supported for the connection type of the RDS instance.
    500CannotDecreaseEssdPerfLevelcannot 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.
    500InvalidEssdStorageSizeinvalid 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 timeSummary of changesOperation
    2023-04-20The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 403 change
      delete Error Codes: 400
      delete Error Codes: 404
      delete Error Codes: 500
    2023-04-07The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2022-09-01The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2021-09-13The error codes of the API operation change.,The input parameters of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: DeletionProtection