All Products
Search
Document Center

ApsaraDB RDS:CreateReadOnlyDBInstance

Last Updated:May 23, 2024

Creates a read-only instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
  • DBInstance
    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. 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. You can call the DescribeRegions operation to query the zone ID.

cn-hangzhou-b
DBInstanceIdstringYes

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

rm-uf6wjk5****
DBInstanceClassstringYes

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.

rds.mys2.small
DBInstanceStorageintegerYes

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.

20
EngineVersionstringYes

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

Note The 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.

Note The 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 instance. Valid values:

    • Basic: RDS Basic Edition
    • HighAvailability (default): RDS High-availability Edition
    • AlwaysOn: RDS Cluster Edition
    Note The read-only instances of the primary instance that run PostgreSQL and use cloud disks run RDS Basic Edition. Therefore, set this parameter to Basic.
    HighAvailability
    DBInstanceStorageTypestringNo

    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
    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.
    Note If 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 (default): disables the feature.
    Note You can enable the release protection feature for the read-only instance only when you set the Billing Method parameter to Pay-As-You-Go.
    true
    PortstringNo

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

    Valid values: 1000 to 65534.

    3306
    AutoPaybooleanNo

    Specifies whether to enable the automatic payment feature. Valid values:

    1. true: enables the feature. Make sure that your account balance is sufficient.
    2. false: disables the feature. An unpaid order is generated.
    Note Default value: true. If your account balance is insufficient, you can set the AutoPay parameter to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.
    false
    IoAccelerationEnabledstringNo

    A reserved parameter.

    None

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    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.-
    400InvalidDBInstanceClass.OfflineThe specified instance type is no longer provided. Please specify another instance type.The instance type that you select is no longer available. Select another instance type.
    400SYSTEM.CONCURRENT_OPERATEConcurrent operation is detected.Concurrent operations are run in the system.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
    400InvalidDBInstanceName.DuplicateSpecified DB instance name already exists in the Aliyun RDS.The operation failed. The instance name already exists. Specify a different name and try again.
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
    400pay.noCreditCardAccount not bound to credit card.-
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
    400Api.NotSupportSpecified api is not supported.The current interface does not support.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400KmsApiErrorUser secret key invalid.The user key is invalid.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
    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.-
    403IncorrectCharacterTypeCurrent DB instance character type does not support this operation.This operation is not supported for the character type of the instance.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
    403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    404IncorrectDBInstanceConnTypeCurrent DB instance conn type does not support this operation.The operation is not supported for the connection type of the RDS instance.
    404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.The RDS instance cannot be found. Check the ID or name of the RDS instance.
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
    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.
    500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-05-23The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2024-05-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2024-04-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2024-01-04The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: BurstingEnabled
      Added Input Parameters: IoAccelerationEnabled
    2023-11-23The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 403 change
      delete Error Codes: 400
      delete Error Codes: 404
      delete Error Codes: 500
    2023-11-21The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2023-11-07The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 404 change
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 500
    2023-09-11The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Port
    2023-08-10The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2023-06-02The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: AutoPay
    2023-04-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 403 change
      delete Error Codes: 400
      delete Error Codes: 404
      delete Error Codes: 500
    2023-04-07The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2022-09-01The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2021-09-13The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DeletionProtection