全部产品
Search
文档中心

云数据库 RDS:CreateReadOnlyDBInstance - 创建只读实例

更新时间:Jun 13, 2024

该接口用于为RDS实例创建一个只读实例。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:CreateReadOnlyDBInstanceWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
ClientTokenstring

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

ETnLKlblzczshOTUbOC****
RegionIdstring

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

cn-hangzhou
ZoneIdstring

可用区 ID。可调用 DescribeRegions 获取。

cn-hangzhou-b
DBInstanceIdstring

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

rm-uf6wjk5****
DBInstanceClassstring

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

mysqlro.n2.small.1c
DBInstanceStorageinteger

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

20
EngineVersionstring

数据库版本号。必须与主实例相同。

  • MySQL 数据库取值:5.65.78.0
  • SQL Server 数据库取值:2017_ent、2019_ent、2022_ent
  • PostgreSQL 数据库取值:10.0、11.0、12.0、13.0、14.0、15.0
5.6
PayTypestring

付费类型,取值:

  • Postpaid:后付费(按量付费)
  • Prepaid:预付费(包年包月)
Postpaid
DBInstanceDescriptionstring

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

说明 不能以 http://和 https://开头。
testReadOnly
InstanceNetworkTypestring

只读实例的网络类型,取值:

  • VPC:专有网络
  • Classic:经典网络

默认创建专有网络实例,需要传入 VPCIdVSwitchId

说明 只读实例的网络类型可以和主实例不同。
Classic
VPCIdstring

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

说明
  • 主实例的存储类型为本地 SSD 盘时,只读实例可以选择任意 VPC 网络。
  • 主实例的存储类型为云盘时,只读实例 VPC 必须和主实例保持一致。
  • vpc-uf6f7l4fg90****
    VSwitchIdstring

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

    vsw-uf6adz52c2p****
    PrivateIpAddressstring

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

    172.16.XX.XX
    ResourceGroupIdstring

    资源组 ID。

    rg-acfmy****
    Categorystring

    实例系列,取值:

    • Basic:基础系列
    • HighAvailability:高可用系列(默认值)
    • AlwaysOn:集群系列
    说明 PostgreSQL 云盘实例的只读实例为基础系列,因此必须传入 Basic
    HighAvailability
    DBInstanceStorageTypestring

    实例储存类型,取值:

    • local_ssd:本地 SSD 盘
    • cloud_ssd:SSD 云盘
    • cloud_essd:ESSD PL1 云盘
    • cloud_essd2:ESSD PL2 云盘
    • cloud_essd3:ESSD PL3 云盘
    说明
  • RDS MySQL 主实例为本地 SSD 盘,则仅支持传入local_ssd;RDS MySQL 主实例为云盘,则仅支持传入云盘存储类型。
  • SQL Server 仅支持传入云盘存储类型。
  • local_ssd
    DedicatedHostGroupIdstring

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

    dhg-4n****
    TargetDedicatedHostIdForMasterstring

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

    i-bp****
    GdnInstanceNamestring

    备用参数。

    test
    TddlBizTypestring

    备用参数。

    test
    TddlRegionConfigstring

    备用参数。

    test
    InstructionSetArchstring

    备用参数。

    test
    UsedTimestring

    指定购买时长。取值:

    • 当参数 PeriodYear 时,UsedTime 取值为 1~5
    • 当参数 PeriodMonth 时,UsedTime 取值为 1~9
    说明 PayTypePrepaid,需要传入该参数。
    1
    Periodstring

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

    • Year:包年
    • Month:包月
    Month
    AutoRenewstring

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

    • true:是
    • false:否
    说明
  • 按月购买,则自动续费周期为 1 个月。
  • 按年购买,则自动续费周期为 1 年。
  • true
    DeletionProtectionboolean

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

    • true:开启
    • false:关闭(默认值)
    说明 计费方式按量付费时支持开启。
    true
    Portstring

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

    取值范围:1000~65534

    3306
    BurstingEnabledboolean

    无效参数,无需配置。

    false
    AutoPayboolean

    是否自动支付。 取值范围:

    1. true:自动支付。您需要确保账户余额充足。

    2. false:只生成订单不扣费。

    说明 默认值为 true。如果您的支付方式余额不足,可以将参数 AutoPay 设置为 false,此时会生成未支付订单,您可以登录 RDS 管理控制台自行支付。
    false
    IoAccelerationEnabledstring

    预留参数。

    0

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    DBInstanceIdstring

    创建的只读实例 ID。

    rr-uf6wjk5****
    RequestIdstring

    请求 ID。

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

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

    3306
    ConnectionStringstring

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

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

    订单 ID。

    10078937****

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    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.当前的安全IP地址已被占用或不在有效区间内,请重新设置安全IP地址。
    400InvalidParameterThe specified parameter dbInstanceId is not valid.-
    400OperationDeniedVPC IP is in use, please check.操作失败,当前VPC IP已经被使用。
    400InvalidZoneId.NotSupportedThe Specified vpc Zone not supported.当前可用区不支持创建VPC网络类型实例,请更换可用区。
    400InvalidAvZone.NotSupportSpecified availableArea multiZone does not support in RDS.指定的availableArea multiZone在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.主实例和只读实例engineVersion不匹配。
    400InvalidDBInstanceClass.OfflineThe specified instance type is no longer provided. Please specify another instance type.当前所选的实例规格已下线,请更换其他实例规格。
    400SYSTEM.CONCURRENT_OPERATEConcurrent operation is detected.系统中存在并发操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400InvalidDBInstanceName.DuplicateSpecified DB instance name already exists in the Aliyun RDS.操作失败,实例名称已存在,请修改实例名称后重试。
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
    400InvalidRequestIdThe request is copy, check your token.重复请求,请检查token。
    400Order.ComboInstanceNotAllowOperateA 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
    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.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
    400Commodity.InvalidComponentThe 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.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
    400Price.CommoditySysCommodity system call exception.商品系统调用异常。
    400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
    400Order.PeriodInvalidThere 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.您选购的服务存在未支付订单,请支付或作废后再下单。
    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.您的基本信息未完善,请在操作前先完善您的基本信息。
    400Risk.RiskControlRejectionYour 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.当前接口不支持。
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
    400KmsApiErrorUser secret key invalid.用户密钥失效。
    400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
    400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
    400IncorrectTargetClasscodeThe current instance type does not support this operation.当前规格不支持此操作。
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.链接地址名重复,请重新设置连接字符串。
    400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
    403OperationDenied.PrimaryDBInstanceStatusThe operation is not permitted due to status of primary instance.操作失败,无法迁移专属集群内非运行状态的RDS实例。
    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.当前实例字符类型不支持此操作。
    403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
    403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
    403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
    404IncorrectDBInstanceConnTypeCurrent DB instance conn type does not support this operation.当前数据库实例的连接类型不支持此操作。
    404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.没有找到指定的实例,请检查实例的正确性。
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
    500CannotDecreaseEssdPerfLevelcannot decrease cloud essd performance level.存储类型变更校验失败,SQL Server云盘实例只能转为云盘,SSD只能升级到SSD或ESSD。
    500InvalidEssdStorageSizeinvalid cloud essd storage size.云盘存储规格有误,请检查存储规格配置。
    500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-05-28OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
      删除错误码:500
    2024-05-23OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
      删除错误码:500
    2024-05-22OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
      删除错误码:500
    2024-04-18OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
      删除错误码:500
    2024-01-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:BurstingEnabled
      新增入参:IoAccelerationEnabled
    2023-11-23OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 403 变更
      删除错误码:400
      删除错误码:404
      删除错误码:500
    2023-11-21OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
      删除错误码:500
    2023-11-07OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 404 变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
    2023-09-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:Port
    2023-08-10OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
      删除错误码:500
    2023-06-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:AutoPay
    2023-04-20OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 403 变更
      删除错误码:400
      删除错误码:404
      删除错误码:500
    2023-04-07OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
      删除错误码:500
    2022-09-01OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
      删除错误码:500
    2021-09-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:DeletionProtection