CreateReadOnlyDBInstance_云数据库 RDS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

流控信息

请求速率为10/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
rds:CreateReadOnlyDBInstance
Create
DBInstance
acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
rds:ResourceTag

请求参数

字段名称字段详情
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

示例值:ETnLKlblzczshOTUbOC****
RegionIdstring

地域 ID。只读实例的地域必须和主实例相同。可调用 DescribeRegions 获取。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
ZoneIdstring

可用区 ID。可调用 DescribeRegions 获取。展开详情

示例值:cn-hangzhou-b
DBInstanceIdstring

主实例 ID。可调用 DescribeDBInstances 获取。

示例值:rm-uf6wjk5****参考取值来源:
    CloneDBInstance
    CreateDBInstance
    ReceiveDBInstance
    ModifyDBInstanceSpec
    RecoveryDBInstance
    DescribeDBInstances
    CalculateDBInstanceWeight
    MigrateDBNodes
    UpgradeDBInstanceMajorVersion
    TransformDBInstancePayType
    EvaluateLocalExtendDisk
    RestoreDdrTable
    RebuildReplicationLink
DBInstanceClassstring

实例规格,详见只读实例规格列表。建议只读实例规格不小于主实例规格,否则易导致只读实例延迟高、负载高等现象。

示例值:mysqlro.n2.small.1c参考取值来源:
    CreateDBInstance
    DescribeDBInstances
DBInstanceStorageinteger<int32>

存储空间,只读实例存储空间需要大于或等于主实例存储空间。取值:请参见只读实例规格列表存储空间列。每 5 GB 进行递增,单位:GB。

示例值:20
EngineVersionstring

数据库版本号。必须与主实例相同。展开详情

示例值:5.6参考取值来源:
    DescribeDBMiniEngineVersions
PayTypestring

付费类型,取值:展开详情

示例值:Postpaid
DBInstanceDescriptionstring

实例描述,长度为 2~256 个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。展开详情

示例值:testReadOnly
InstanceNetworkTypestring

只读实例的网络类型,取值:展开详情

示例值:Classic参考取值来源:
    DescribeDBInstanceNetInfo
VPCIdstring

只读实例的专有网络 VPC ID。当 InstanceNetworkType 配置为空或 VPC 时需要传入。展开详情

示例值:vpc-uf6f7l4fg90****
VSwitchIdstring

只读实例的虚拟交换机 ID。当 InstanceNetworkType 配置为空或 VPC 时需要传入。

示例值:vsw-uf6adz52c2p****参考取值来源:
    DescribeVSwitches
PrivateIpAddressstring

设置只读实例的内网 IP,需要在指定交换机的 IP 地址范围内。系统默认通过 VPCIdVSwitchId 自动分配。

示例值:172.16.XX.XX
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfmy****参考取值来源:
    DescribeResourceDetails
Categorystring

实例系列,取值:展开详情

示例值:HighAvailability
DBInstanceStorageTypestring

实例储存类型,取值:展开详情

示例值:local_ssd参考取值来源:
    CreateDBInstance
    DescribeDBInstances
DedicatedHostGroupIdstring

在专属集群内创建只读实例时指定专属集群 ID。

示例值:dhg-4n****参考取值来源:
    DescribeDedicatedHostGroups
TargetDedicatedHostIdForMasterstring

在专属集群内创建只读实例时,指定主实例的主机 ID。

示例值:i-bp****
GdnInstanceNamestring

备用参数。

示例值:test
TddlBizTypestring

备用参数。

示例值:test
TddlRegionConfigstring

备用参数。

示例值:test
InstructionSetArchstring

备用参数。

示例值:test
UsedTimestring

指定购买时长。取值:展开详情

示例值:1
Periodstring

指定预付费实例为包年或者包月类型。取值:展开详情

示例值:Month
AutoRenewstring

实例是否自动续费,仅在创建包年包月实例时传入。取值:展开详情

示例值:true
DeletionProtectionboolean

是否开启 RDS 释放保护功能。取值:展开详情

示例值:true
Portstring

支持在 RDS MySQL 主实例创建只读实例时初始化端口。展开详情

示例值:3306
BpeEnabledstring

弃用参数,无需配置。

示例值:0
BurstingEnabledboolean

通用云盘 IO 突发功能开关。展开详情

示例值:false
AutoPayboolean

是否自动支付。展开详情

示例值:false
AutoCreateProxyboolean

是否自动创建代理。取值范围:展开详情

示例值:false
IoAccelerationEnabledstring

是否开启通用云盘 IO 加速功能,参数取值含义如下:展开详情

示例值:0
AutoUseCouponboolean

是否使用代金券,取值:展开详情

示例值:true
PromotionCodestring

优惠券 code。

示例值:717446260784

返回参数

字段名称字段详情
ConnectionStringstring

创建的只读实例内网数据库连接地址。

示例值:rr-****.mysql.rds.aliyuncs.com
DBInstanceIdstring

创建的只读实例 ID。

示例值:rr-uf6wjk5****
OrderIdstring

订单 ID。

示例值:10078937****
Portstring

创建的只读实例内网数据库连接端口。

示例值:3306
RequestIdstring

请求 ID。

示例值:1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
400
InvalidParameter
The specified parameter dbInstanceId is not valid.诊断
400
OperationDenied
VPC IP is in use, please check.诊断
400
InvalidZoneId.NotSupported
The Specified vpc Zone not supported.诊断
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.诊断
400
InvalidDBInstanceClass.Offline
The specified instance type is no longer provided. Please specify another instance type.诊断
400
SYSTEM.CONCURRENT_OPERATE
Concurrent operation is detected.诊断
400
Price.PricingPlanResultNotFound
Pricing plan price result not found.诊断
400
InvalidDBInstanceName.Duplicate
Specified DB instance name already exists in the Aliyun RDS.诊断
400
InvalidInstanceLevel.DiskType
Specified instance level not support request disk type诊断
400
InvalidRequestId
The request is copy, check your token.诊断
400
InvalidParam.InstanceNetworkType
Creation of classic network instances is not supported.诊断
400
Order.ComboInstanceNotAllowOperate
A package instance is not allowed to operate independently.诊断
400
Order.NoRealNameAuthentication
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.诊断
400
InsufficientAvailableQuota
Your account quota limit is less than 0, please recharge before trying to purchase.诊断
400
CommodityServiceCalling.Exception
Failed to call commodity service.诊断
400
RegionDissolvedEOM
Dear 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.诊断
400
Commodity.InvalidComponent
The module you purchased is not legal, please buy it again.诊断
400
RegionEndTimeDissolvedAustralia
Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.诊断
400
Price.CommoditySys
Commodity system call exception.诊断
400
Pay.InsufficientBalance
Insufficient available balance.诊断
400
Order.PeriodInvalid
There is a problem with the period you selected, please choose again.诊断
400
pay.noCreditCard
Account not bound to credit card.诊断
400
Order.InstHasUnpaidOrder
There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.诊断
400
noAvailablePaymentMethod
No payment method is specified for your account. We recommend that you add a payment method.诊断
400
BasicInfoUncompleted
Your information is incomplete. Complete your information before the operation.诊断
400
Risk.RiskControlRejection
Your account is abnormal, please contact customer service for details.诊断
400
Api.NotSupport
Specified api is not supported.诊断
400
ContainForbiddenLabelError
There is a label that prohibits placing orders. Please contact your distributor for assistance.诊断
400
InvalidDBInstanceId.NotFound
The DBInstanceId provided does not exist in records.诊断
400
InvalidParam
Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.诊断
400
KmsApiError
User secret key invalid.诊断
400
System.SaleValidateFailed
Sales expression validation system error.诊断
400
Abs.InvalidAccount.NotFound
account is not found.诊断
400
SqlExecuteFailedOrTimeout
sql command execution failed or timed out:%s.诊断
400
ColdData.EngineVersionNotSupport
The current instance engine version not support coldDataEnabled.诊断
400
ColdData.MinorVersionNotSupport
The current instance minor version not support coldDataEnabled.诊断
400
IncorrectTargetClasscode
The current instance type does not support this operation.诊断
400
InvalidConnectionString.Duplicate
Specified connection string already exists in the RDS.诊断
400
RequiredParam.NotFound
Required input param is not found.诊断
400
Parameters.Invalid
Parameter error, please check the parameters.诊断
400
BackupPolicyNotSupport
Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.诊断
400
InvalideStatus.Format
The instance status does not support this operation.诊断
400
InvalidReleasedKeepPolicy.Format
Specified Released Keep Policy is not valid.诊断
400
InvalidDBInstanceEngineType.Format
the DB instance engine type does not support this operation.诊断
400
Pay.NoCreditCard
No credit cards.诊断
400
VpcNetworkTypeNotSupport
The vpc network type instance does not support this operation.诊断
400
MirrorInsExists
Specified DB instance mirror ins already existed.诊断
400
UnsupportedClassCode
The specified DB instance class stops selling.诊断
400
InvalidBackupSet
The specified database does not exist in the backup set.诊断
400
OrdTCommodityQueryError
Failed to query for product.诊断
400
ProductInstanceReleased
The instance has been released. Please check before placing the order.诊断
400
RegionEndTimeDissolvedIndia
The region is no longer supported.诊断
400
InvalidVSwitchId.Format
The specified vswitch Id format is incorrect.诊断
403
OperationDenied.PrimaryDBInstanceStatus
The operation is not permitted due to status of primary instance.诊断
403
InvalidReadStorageTypePattern
The storage type of the primary instance and the read-only instance do not match.诊断
403
IncorrectCharacterType
Current DB instance character type does not support this operation.诊断
403
InvalidMultiparamZoneInfoList
Zoneinfo list is invaild.诊断
403
OrderStatus.UnPaid
The specified db instance has unpaid order.诊断
403
InvalidReduceDiskSize
The storage capacity after the scale-down must be larger than the used amount.诊断
403
CloudSSDNotSupport
Cloud ssd does not support this operation, please upgrade to essd.诊断
403
InvalidUserOperatorPermission
The user permission does not support this operation.诊断
403
InvalidVswitchId
Specified conn vswitch id is not valid.诊断
403
IncorrectMinorVersion
Current engine minor version does not support operations.诊断
403
OperationDenied.ZoneResource
There is no available zone for inventory.诊断
403
NotInFlowController
Sorry,no permission.诊断
403
InvalidKmsKey
Kms key is disabled.诊断
403
InvalidInstanceLevel.Malformed
Current DB instance level does not support this operation.诊断
404
IncorrectDBInstanceConnType
Current DB instance conn type does not support this operation.诊断
404
InvalidDBInstance.NotFound
The specified instance does not exist or is not supported.诊断
404
InvalidClusterKms
The current instance does not authorized to access the Key Management Service.诊断
404
Request.NotFound
The requested resource is not available.诊断
404
HostInfo.NotFound
The specified host info is not found.诊断
500
CannotDecreaseEssdPerfLevel
cannot decrease cloud essd performance level.诊断
500
InvalidEssdStorageSize
invalid cloud essd storage size.诊断
500
ExternalFailure
The request processing has failed due to external service failure.诊断
500
RequestMetaDataFailed
The service request failed. Please try again later or contact service personnel.诊断
500
InvokeProxyFailure
The request processing has failed due to service failure of rds api.诊断

变更历史

变更时间变更内容概要操作
2025-03-31
变更错误码400
2024-11-19
新增请求参数AutoUseCoupon
新增请求参数PromotionCode
2024-11-14
删除请求参数ServerlessConfig
2024-11-12
新增请求参数ServerlessConfig
2024-11-01
变更请求参数Category
2024-08-27
变更请求参数InstanceNetworkType
2024-08-13
变更错误码400
2024-07-23
新增请求参数AutoCreateProxy
2024-05-28
变更错误码400

相关示例

经典网络中创建只读实例
2021-01-15