DocsICP FilingConsole
Documentation

CreateReadOnlyDBInstance - 创建只读实例

Updated at:
Copy as MD
Product
My Favorites

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

接口说明

适用引擎

  • RDS MySQL

  • RDS PostgreSQL

  • RDS SQL Server

相关功能文档

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rds:CreateReadOnlyDBInstance

create

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
 无

请求参数

名称

类型

必填

描述

示例值
ClientToken

string

否

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

ETnLKlblzczshOTUbOC****
RegionId

string

是

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

cn-hangzhou
ZoneId

string

是

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

  • 若选择部署单可用区，填入一个可用区即可，例如cn-hangzhou-b。

  • 若选择部署多可用区，填入多个可用区并用英文冒号（:）分隔，例如cn-hangzhou-b:cn-hangzhou-c。

  • 填入的可用区数量应小于或等于当前创建的只读实例内的节点数。基础系列只读实例内仅含 1 个节点，高可用系列只读实例内含有 2 个节点（1 个主节点与 1 个备节点）。

cn-hangzhou-b
DBInstanceId

string

是

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

rm-uf6wjk5****
DBInstanceClass

string

是

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

mysqlro.n2.small.1c
DBInstanceStorage

integer

是

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

20
EngineVersion

string

是

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

  • MySQL 数据库取值：5.6、5.7、8.0。

  • SQL Server 数据库取值：2017_ent、2019_ent、2022_ent。

  • PostgreSQL 数据库取值：10.0、11.0、12.0、13.0、14.0、15.0

5.6
PayType

string

是

付费类型。取值：

  • Postpaid：后付费（按量付费）

  • Prepaid：预付费（包年包月）

Postpaid
DBInstanceDescription

string

否

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

说明

不能以 http://和 https://开头。

testReadOnly
InstanceNetworkType

string

否

只读实例的网络类型。取值：

  • VPC：专有网络

  • Classic：经典网络

默认创建专有网络实例，需要传入 VPCId 和 VSwitchId。

说明

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

Classic
VPCId

string

否

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

说明

  • 主实例的存储类型为高性能本地盘时，只读实例可以选择任意 VPC 网络。

  • 主实例的存储类型为云盘时，只读实例 VPC 必须和主实例保持一致。

vpc-uf6f7l4fg90****
VSwitchId

string

否

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

vsw-uf6adz52c2p****
PrivateIpAddress

string

否

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

172.16.XX.XX
ResourceGroupId

string

否

资源组 ID。

rg-acfmy****
Category

string

否

实例系列。取值：

  • Basic：基础系列

  • HighAvailability：高可用系列（默认值）

  • AlwaysOn：集群系列

* Finance：金融版

说明

PostgreSQL 云盘实例的只读实例为基础系列，因此必须传入 Basic。

HighAvailability
DBInstanceStorageType

string

否

实例储存类型。取值：

  • local_ssd：高性能本地盘

  • cloud_ssd：SSD 云盘

  • cloud_essd：ESSD PL1 云盘

  • cloud_essd2：ESSD PL2 云盘

  • cloud_essd3：ESSD PL3 云盘

  • general_essd：高性能云盘

说明

  • RDS MySQL 主实例为高性能本地盘，则仅支持传入local_ssd；RDS MySQL 主实例为云盘，则仅支持传入云盘存储类型。

  • SQL Server 仅支持传入云盘存储类型。

local_ssd
DedicatedHostGroupId

string

否

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

dhg-4n****
TargetDedicatedHostIdForMaster

string

否

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

i-bp****
GdnInstanceName

string

否

备用参数，无需配置。

test
TddlBizType

string

否

备用参数，无需配置。

test
TddlRegionConfig

string

否

备用参数，无需配置。

test
InstructionSetArch

string

否

备用参数，无需配置。

test
UsedTime

string

否

指定购买时长。取值：

  • 当参数 Period 为 Year 时，UsedTime 取值为 1~5。

  • 当参数 Period 为 Month 时，UsedTime 取值为 1~9。

说明

若 PayType 为 Prepaid，需要传入该参数。

1
Period

string

否

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

  • Year：包年

  • Month：包月

Month
AutoRenew

string

否

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

  • true：是

  • false：否

说明

  • 按月购买，则自动续费周期为 1 个月。

  • 按年购买，则自动续费周期为 1 年。

true
DeletionProtection

boolean

否

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

  • true：开启

  • false：关闭（默认值）

说明

仅计费方式为按量付费时支持开启。

true
Port

string

否

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

取值范围：1000~65534。

3306
BpeEnabled

string

否

弃用参数，无需配置。

0
BurstingEnabled

boolean

否

高性能云盘的 IO 性能突发功能开关。取值：

  • true：开启

  • false：关闭

false
IsAnalyticReadOnlyIns

boolean

否

是否创建 DuckDB 分析实例。取值：

  • true：开启

  • false：关闭

说明

当前仅 RDS MySQL 和 RDS PostgreSQL 支持创建 DuckDB 分析实例。

AutoPay

boolean

否

是否自动支付。取值：

  • true：自动支付。您需要确保账户余额充足。

  • false：只生成订单不扣费。

说明

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

false
AutoCreateProxy

boolean

否

是否自动创建代理。取值：

  • true：开启自动创建，默认为通用代理。

  • false：不开启自动创建。

false
IoAccelerationEnabled

string

否

高性能云盘的Buffer Pool Extension（BPE）功能开关。取值：

  • 1：开启

  • 0：不开启

0
AutoUseCoupon

boolean

否

是否使用代金券。取值：

  • true：使用代金券。

  • false（默认）：不使用代金券。

true
PromotionCode

string

否

优惠券 code。

71744626****
CustomExtraInfo

string

否

备用参数，无需配置。

None

返回参数

名称

类型

描述

示例值

object

返回参数详情。

ConnectionString

string

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

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

string

创建的只读实例 ID。

rr-uf6wjk5****
OrderId

string

订单 ID。

10078937****
Port

string

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

3306
RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述
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. 选择云存储类型时，指定 InstanceNetworkType 的值为 Classic 是无效的。
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. 当前的安全IP地址已被占用或不在有效区间内，请重新设置安全IP地址。
400 InvalidParameter The specified parameter dbInstanceId is not valid.
400 OperationDenied VPC IP is in use, please check. 操作失败，当前VPC IP已经被使用。
400 InvalidZoneId.NotSupported The Specified vpc Zone not supported. 当前可用区不支持创建VPC网络类型实例，请更换可用区。
400 InvalidAvZone.NotSupport Specified availableArea multiZone does not support in RDS. 指定的availableArea multiZone在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. 主实例和只读实例engineVersion不匹配。
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. 重复请求，请检查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. 您的账户可用额度小于0，请先充值后再尝试购买。
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. 提供的DBInstanceId不存在。
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. 指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为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. sql命令执行失败或执行超时
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. DB实例引擎类型不支持此操作。
400 Pay.NoCreditCard No credit cards. 无信用卡。
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. vpc网络类型实例不支持此操作。
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. 指定的vswitch Id格式不正确。
400 InvalidParameterValue.NotStandard Invalid parameter format. 指定的参数格式不规范。
400 AtLeastThreeVSwitchAvailableIp The primary vswitch requires at least three available IP addresses. 主交换机至少需要3个可用ip。
400 AtLeastTwoVSwitchAvailableIp The primary vswitch requires at least two available IP addresses. 主交换机至少需要2个可用的ip。
400 DuckDBOperationConflictBetweenPrimaryAndReadOnlyInstance Current instance is already attached to another duckdb instance, operation is conflict. 当前实例已经关联了另一个 DUCKDB 实例，这和当前的 DUCKDB 操作冲突了
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. 由于rds api服务失败，请求处理失败。
403 OperationDenied.PrimaryDBInstanceStatus The operation is not permitted due to status of primary instance. 操作失败，无法迁移专属集群内非运行状态的RDS实例。
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. SSD盘不支持此操作，请升级至ESSD。
403 InvalidUserOperatorPermission The user permission does not support this operation. 用户权限不支持此操作。
403 InvalidVswitchId Specified conn vswitch id is not valid. 指定的VSwitchId格式不正确或为空
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. Kms key已禁用。
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. 当前数据库实例级别不支持此操作。
403 BasicCategoryNotSupport The Basic category is not supported. 不支持基础版系列
403 GuardDBInstanceNotSupport Guard instance 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. 指定的主机信息不存在。

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

变更历史

更多信息，参考变更详情。