CreateDBInstance - 创建一个RDS实例

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

该接口用于创建RDS实例。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

警告 该 API 操作涉及费用,请仔细阅读相关功能文档后再进行操作。

调试

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

授权信息

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

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

请求参数

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

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
Enginestring

数据库类型,取值:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
MySQL
EngineVersionstring

数据库版本,取值:

  • 常规实例
    • MySQL:5.55.65.78.0
    • SQL Server:08r2_ent_ha(云盘版,已停售)、2008r2(本地盘,已停售)、2012(企业版单机)、2012_ent_ha2012_std_ha2012_web2014_ent_ha2014_std_ha2016_ent_ha2016_std_ha2016_web2017_ent2017_std_ha2017_web2019_ent2019_std_ha2019_web2022_ent2022_std_ha2022_web
    • PostgreSQL:10.011.012.013.014.015.016.0
    • MariaDB:10.3
  • Serverless 实例
    • MySQL:5.78.0
    • SQL Server:2016_std_sl2017_std_sl2019_std_sl
    • PostgreSQL:14.015.016.0
说明
  • MariaDB 不支持创建 Serverless 实例。
  • SQL Server 实例中_ent表示企业集群版、_ent_ha表示企业版、_std_ha表示标准版、_web表示 Web 版。
  • SQL Server 2014 版本实例国际站不支持售卖。
  • Babelfish for RDS PostgreSQL 实例只支持大版本 15.0。
  • 8.0
    DBInstanceClassstring

    实例规格。可以指定标准版或倚天版规格,详情请参见主实例规格表

    如需创建 Serverless 实例,请传入如下取值:

    • MySQL 基础系列:mysql.n2.serverless.1c
    • MySQL 高可用系列:mysql.n2.serverless.2c
    • SQL Server:mssql.mem2.serverless.s2
    • PostgreSQL 基础系列:pg.n2.serverless.1c
    • PostgreSQL 高可用系列:pg.n2.serverless.2c
    mysql.n2.medium.2c
    DBInstanceStorageinteger

    实例存储空间。单位:GB。每 5GB 进行递增,取值范围请参见实例规格表

    100
    SystemDBCharsetstring

    弃用参数,无需配置。

    gbk
    DBInstanceNetTypestring

    实例的网络连接类型。固定配置 Intranet,表示内网连接。

    Intranet
    DBInstanceDescriptionstring

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

    说明 不能以 http:// 和 https:// 开头。
    testInstance
    SecurityIPListstring

    该实例的 IP 白名单。多条记录请以半角逗号(,)隔开,不可重复,最多 1000 条记录。支持如下两种格式:

    • IP 地址形式,例如:10.10.XX.XX。
    • CIDR 形式,例如:10.10.XX.XX/24(无类域间路由,24 表示了地址中前缀的长度,范围为 1~32)。
    10.10.XX.XX/24
    ClientTokenstring

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

    ETnLKlblzczshOTUbOCz****
    PayTypestring

    实例的付费类型,取值:

    说明 系统会自动生成订单并自动完成支付,无需手动确认支付。
    Postpaid
    ZoneIdstring

    主节点可用区 ID。

    • 指定了 VPC 和交换机时,此处必须传入目标交换机所在的可用区 ID,否则无法创建成功。
    • 对于高可用系列实例,还需传入 ZoneIdSlave1,以此决定实例是单可用区部署还是多可用区部署。
    • 对于三节点企业系列实例,还需传入 ZoneIdSlave1ZoneIdSlave2,以此决定实例是单可用区部署还是多可用区部署。
    • 对于 RDS 集群系列实例,两节点还需要传入 ZoneIdSlave1,三节点还需要传入 ZoneIdSlave1ZoneIdSlave2
    cn-hangzhou-b
    ZoneIdSlave1string

    备节点可用区 ID。

    • 如果填写 Auto,则表示多可用区部署并且会自动为备节点选择可用区。
    • 如果和 ZoneId 相同,则为单可用区部署。
    • 如果和 ZoneId 不同,则为多可用区部署。
    cn-hangzhou-c
    ZoneIdSlave2string

    RDS MySQL 集群系列实例支持在新建实例时,同时创建 1~2 个备节点。有此需求时,您可通过本参数指定第 2 个备节点的可用区。

    cn-hangzhou-d
    InstanceNetworkTypestring

    实例的网络类型,取值:

    • VPC:专有网络。
    • Classic:经典网络。
    说明
  • MySQL 云盘实例只支持专有网络,此参数必须配置为 VPC
  • PostgreSQL 和 MariaDB 实例只支持专有网络,此参数必须配置为 VPC
  • SQL Server 单机版和 Web 版实例支持经典网络和专有网络。其余实例只支持专有网络,此参数必须配置为 VPC
  • VPC
    ConnectionModestring

    实例的访问模式,取值:

    • Standard:标准访问模式。
    • Safe:数据库代理模式。

    默认为 RDS 系统分配。

    说明 SQL Server 2012、2016、2017 只支持标准访问模式。
    Standard
    VPCIdstring

    专有网络(VPC) ID。

    说明 网络类型 InstanceNetworkType 取值为 VPC 时生效。
    vpc-****
    VSwitchIdstring

    虚拟交换机 ID。虚拟交换机所在的可用区必须和 ZoneId 中传入的可用区 ID 相对应。

    • 网络类型 InstanceNetworkType 需为 VPC
    • 若您填写了 ZoneSlaveId1(备节点可用区 ID),并且不为 Auto,此处需填写两个交换机 ID,并使用半角逗号(,)隔开。
    • VSwitchId 中不能包含空格#&%等特殊字符。
    vsw-****
    PrivateIpAddressstring

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

    172.16.XX.XX
    UsedTimestring

    指定购买时长,取值:

    • 当参数 Period=Year 时,UsedTime 取值为1~5
    • 当参数 Period=Month 时,UsedTime 取值为1~11
    说明 若付费类型为 Prepaid 则该参数必须传入。
    2
    Periodstring

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

    • Year:包年。
    • Month:包月。
    说明 若付费类型为 Prepaid 则该参数必须传入。
    Year
    ResourceGroupIdstring

    资源组 ID。

    rg-acfmy****
    DBInstanceStorageTypestring

    实例存储类型,取值:

    • local_ssd:本地 SSD 盘(推荐)。
    • general_essd:通用云盘(推荐)。
    • cloud_essd:ESSD PL1 云盘。
    • cloud_essd2:ESSD PL2 云盘。
    • cloud_essd3:ESSD PL3 云盘。
    • cloud_ssd:SSD 云盘(不推荐,部分地域已经停止售卖)。

    本参数的默认值根据 DBInstanceClass 参数中传的规格代码自动判断:

    • 规格代码为本地盘规格:默认值为local_ssd
    • 规格代码为云盘规格:默认值为cloud_essd
    说明 Serverless 实例仅支持 ESSD PL1 云盘和通用云盘。
    general_essd
    BusinessInfostring

    业务扩展参数。

    121436975448952
    EncryptionKeystring

    同地域内的云盘加密的密钥 ID。传入此参数表示开启云盘加密(开启后无法关闭),并且需要传入 RoleARN

    您可以在密钥管理服务控制台查看密钥 ID,也可以创建新的密钥。详情请参见创建密钥

    说明
  • 对于 RDS MySQL、RDS PostgreSQL 和 RDS SQL Server 可不传此参数,仅需要传入 RoleARN 即可使用服务密钥创建云盘加密实例。
  • 支持 RAM 授权允许子账号创建实例时必须开启云盘加密,若不开启云盘加密,则不允许创建实例,RAM 子账号授权配置如下: {"Version":"1","Statement":[{"Effect":"Deny","Action":"rds:CreateDBInstance","Resource":"*","Condition":{"StringEquals":{"rds:DiskEncryptionRequired":"false"}}}]}
    警告 此配置也会同步影响控制台创建实例 CreateOrder 接口。
  • 0d24*****-da7b-4786-b981-9a164dxxxxxx
    RoleARNstring

    主账号授权 RDS 云服务账号访问 KMS 权限的全局资源描述符(ARN)。您可以通过 CheckCloudResourceAuthorized 接口查看 ARN 信息。

    acs:ram::1406****:role/aliyunrdsinstanceencryptiondefaultrole
    AutoRenewstring

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

    • true
    • false
    说明
  • 按月购买时,自动续费周期为 1 个月。
  • 按年购买时,自动续费周期为 1 年。
  • true
    Categorystring

    实例系列,取值:

    • 常规实例
      • Basic:基础系列。
      • HighAvailability:高可用系列。
      • cluster:MySQL 或 PostgreSQL 集群系列。
      • AlwaysOn:SQL Server 集群系列。
      • Finance:三节点企业系列。
    • Serverless 实例
      • serverless_basic:Serverless 基础系列。(仅适用 MySQL 和 PostgreSQL)

      • serverless_standard:Serverless 高可用系列。(仅适用 MySQL 和 PostgreSQL)

      • serverless_ha:SQL Server Serverless 高可用系列。

      说明 若创建 Serverless 实例,该参数必传。
    HighAvailability
    DedicatedHostGroupIdstring

    专属集群主机组 ID。

    在专属集群内创建 RDS 实例时需要指定。

    • 您可以调用 DescribeDedicatedHostGroups 接口查询 RDS 主机组信息。
    • 如您还未创建 RDS 主机组,可以调用 CreateDedicatedHostGroup 接口创建。
    dhg-4n****
    TargetDedicatedHostIdForMasterstring

    专属集群中主实例的主机 ID。

    在专属集群内创建 RDS 实例时需要指定。如不指定该参数,系统默认自动分配主机。

    • 您可以调用 DescribeDedicatedHosts 接口查询 RDS 主机组内的主机信息。
    • 如您还没有主机,可以调用 CreateDedicatedHost 接口添加。
    i-bp****
    TargetDedicatedHostIdForSlavestring

    专属集群中备实例的主机 ID。

    在专属集群内创建 RDS 高可用系列或三节点企业系列实例时需要指定。如不指定该参数,系统默认自动分配主机。

    • 您可以调用 DescribeDedicatedHosts 接口查询 RDS 专属集群内的主机信息。
    • 如您还没有主机,可以调用 CreateDedicatedHost 接口添加。
    i-bp****
    TargetDedicatedHostIdForLogstring

    专属集群中日志实例的主机 ID。

    在专属集群内创建 RDS 三节点企业系列实例时需要指定。如不指定该参数,系统默认自动分配主机。

    • 您可以调用 DescribeDedicatedHosts 接口查询 RDS 专属集群内的主机信息。
    • 如您还没有主机,可以调用 CreateDedicatedHost 接口添加。
    i-bp****
    DBParamGroupIdstring

    参数模板 ID。可调用 DescribeParameterGroups 查询。

    说明 仅 MySQL 和 PostgreSQL 支持此参数,如不配置,将采用系统默认参数模板,您也可以自定义参数模板后,在此处使用。
    rpg-sys-****
    DBTimeZonestring

    设置实例的时区,仅在 EngineMySQLPostgreSQL 时生效。

    • EngineMySQL
      • 此参数配置 UTC 时区。取值范围为**-12:59** ~ +13:00
      • 本地 SSD 盘实例可以使用命名时区,例如 Asia/Hong_Kong。命名时区的详细信息,请参见命名时区参考
    • EnginePostgreSQL
      • 此参数配置命名时区,不支持 UTC 时区。命名时区的详细信息,请参见命名时区参考
      • 仅当实例为 PostgreSQL 云盘时,该参数可配置。
    说明
  • 购买主实例时支持设置时区,只读实例不支持设置时区,只读实例将继承主实例时区。
  • 如果不配置此参数,系统将根据您购买实例的地域,选择默认时区。
  • +08:00
    DBIsIgnoreCasestring

    表名是否区分大小写,取值:

    • true:不区分大小写(默认)。
    • false:区分大小写。
    true
    TargetMinorVersionstring

    指定创建的 RDS 实例的内核小版本,仅在创建 MySQL 或 PostgreSQL 实例时需要传入。 格式:

    • MySQL:<实例版本>_<数字版本号>。例如rds_20200229xcluster_20200229xcluster80_20200229。说明如下:
      • rds:高可用系列或基础系列。

      • xcluster:MySQL 5.7 三节点企业系列。

      • xcluster80:MySQL 8.0 三节点企业系列。

      说明 数字版本号可通过调用 DescribeDBMiniEngineVersions 接口查询。各版本差异,请参见AliSQL 小版本 Release Notes
    • PostgreSQL:rds_postgres_<大版本>00_<小版本号>。例如rds_postgres_1400_20220830。说明如下:
      • 1400:PostgreSQL 大版本为 14。

      • 20220830:AliPG 内核小版本,可通过调用 DescribeDBMiniEngineVersions 接口查询。各版本差异,请参见PostgreSQL 小版本 Release Notes

      说明 如果 BabelfishConfig 中配置了启用 Babelfish,则 RDS PostgreSQL 实例小版本格式为:rds_postgres_大版本 00_AliPG 内核小版本_babelfish
    rds_20200229
    StorageAutoScalestring

    存储空间自动扩容开关,仅 MySQL 和 PostgreSQL 支持,取值:

    • Enable:开启。
    • Disable:关闭(默认)。
    说明 您也可以在实例创建完成之后,调用 ModifyDasInstanceConfig 进行调整。更多信息,请参见设置存储空间自动扩容
    Disable
    StorageThresholdinteger

    存储空间自动扩容触发阈值(百分比),取值:

    • 10
    • 20
    • 30
    • 40
    • 50
    说明 StorageAutoScaleEnable 时该参数必填。
    50
    StorageUpperBoundinteger

    存储空间自动扩容的总存储空间上限值,即自动扩容不会导致实例总存储空间超过该值。单位:GB。

    说明
  • 取值需大于等于 0。
  • StorageAutoScaleEnable 时必填。
  • 2000
    DryRunboolean

    是否对本次创建实例的操作执行预检查,取值:

    • true:执行预检查操作,不创建实例。检查项目包含请求参数、请求格式、业务限制和库存等。
    • false:发送正常请求,通过检查后直接创建实例(默认)。
    false
    UserBackupIdstring

    用户备份 ID。可调用 ListUserBackupFiles 接口查询。传入该参数,可基于用户备份创建实例。

    如需传入此参数,有如下限制:

    • PayType 参数必须为 Postpaid
    • Engine 参数必须为 MySQL
    • EngineVersion 参数必须为5.7
    • Category 参数必须为 Basic
    67798****
    Amountinteger

    指定需要创建的 RDS MySQL 实例数量。本参数仅适用于批量创建 RDS MySQL 实例。

    取值范围:1~20;默认值:1

    说明
  • 创建多个 RDS MySQL 实例时,可以考虑通过Tag.KeyTag.Value参数给同一批次的实例打上标签,以方便创建完成后通过标签管理该批次的实例。
  • 完成多个 RDS MySQL 实例的创建后,接口只会返回 TaskIdRequestIdMessage 参数,不会返回其他详情参数。如需查询个体实例的详情,可调用 DescribeDBInstanceAttribute 接口。
  • engine 参数非 MySQL,而本参数的值大于 1 时,接口会调用失败并返回错误码InvalidParam.Engine
  • 2
    CreateStrategystring

    批量创建实例策略。本参数仅在 Amount 参数大于 1 时生效,取值:

    • Atomicity(默认值):原子性。即同一批次的实例要么全部创建成功,若有一个创建失败,则所有实例创建失败。
    • Partial:非原子性。即实例的创建不受同一批次中其他实例的影响。
    Atomicity
    Tagarray<object>

    标签列表。

    object

    标签列表详情内容。

    Keystring

    标签键。传入此参数为实例绑定标签。

    • 若传入的标签键已存在,则直接为实例绑定该标签键。可调用 ListTagResources 查询已创建的标签。
    • 若传入的标签键不存在,则先创建再为实例绑定该标签键。
    • 不允许传入空字符串。
    • 该参数与Tag.Value参数为配套参数,不可单独使用。
    testkey1
    Valuestring

    标签键对应的标签值。传入此参数为实例绑定标签。

    • 若对应的标签键中存在传入的标签值,则直接为实例绑定该标签值。可调用 ListTagResources 查询已创建的标签。
    • 若对应的标签键中不存在传入的标签值,则先创建再为实例绑定该标签值。
    • 该参数与Tag.Key参数为配套参数,不可单独使用。
    testvalue1
    DeletionProtectionboolean

    是否开启 RDS 释放保护功能,仅按量付费实例支持,取值:

    • true:开启。
    • false:关闭(默认)。
    true
    BabelfishConfigstring

    Babelfish for RDS PostgreSQL 配置信息。

    配置格式:{"babelfishEnabled":"true","migrationMode":"xxxxxxx","masterUsername":"xxxxxxx","masterUserPassword":"xxxxxxxx"}

    参数含义如下:

    • babelfishEnabled:是否开启 Babelfish,开启为 true,该参数不配置默认不开启。
    • migrationMode:数据库模式,单数据库模式配置为single-db,多数据库模式配置为multi-db
    • masterUsername:初始化管理账号。由小写字母、数字、下划线组成,以字母开头,以字母或数字结尾,最多 63 个字符,且不能以 pg 开头。
    • masterUserPassword:管理账号的密码。由大写、小写、数字、特殊字符组成,至少包含三种,长度为 8-32 位;特殊字符包括! @ # $ % ^ & * () _ + - =
    说明 该参数仅适用于 RDS PostgreSQL 实例,Babelfish for RDS PostgreSQL 的更多介绍,请参见 Babelfish 简介
    {"babelfishEnabled":"true","migrationMode":"single-db","masterUsername":"babelfish_user","masterUserPassword":"Babelfish123!"}
    ServerlessConfigobject

    RDS Serverless 实例的相关设置。创建 Serverless 实例时必传。

    说明 MariaDB 不支持创建 Serverless 实例。
    MaxCapacitydouble

    实例 RCU(RDS Capacity Unit)自动扩缩范围的最大值。取值:

    • MySQL:1~32
    • SQL Server:2~8
    • PostgreSQL:1~14
    说明 该参数的值必须大于等于 MinCapacity,且仅支持传入整数
    8
    MinCapacitydouble

    实例 RCU 自动扩缩范围的最小值。取值:

    • MySQL:0.5~32
    • SQL Server:2~8(仅支持整数)
    • PostgreSQL:0.5~14
    说明 该参数的值必须小于等于 MaxCapacity
    0.5
    AutoPauseboolean

    是否开启 Serverless 实例的智能暂停和启动。取值:

    • true:启用。
    • false:不启用(默认)。
    说明 仅 MySQL 和 PostgreSQL 的 Serverless 实例需设置该参数。如果 10 分钟无任何连接将进入暂停状态,当连接进入时会自动唤醒。
    true
    SwitchForceboolean

    是否开启 Serverless 实例的强制弹性扩缩容。取值:

    • true:启用。
    • false:不启用(默认)。
    说明
  • 仅 MySQL 和 PostgreSQL 的 Serverless 实例需设置该参数。开启该参数后,实例进行强制扩缩容时会有 30~120 秒的服务不可用,请根据实际情况谨慎使用。
  • 实例 RCU 的弹性扩缩容通常会立刻生效,但在某些特殊情况下(例如大事务执行中)无法即刻完成扩缩容,此时可开启本参数进行强制扩缩容。
  • false
    ConnectionStringstring

    数据库内网连接地址。

    rm-uf6wjk5****.mysql.rds.aliyuncs.com
    Portstring

    支持在创建 RDS 实例时初始化端口。取值范围:

    • MySQL:1000~65534
    • PostgreSQL、SQL Server、MariaDB:1000~5999
    3306
    BpeEnabledstring

    弃用参数,无需配置。

    0
    BurstingEnabledboolean

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

    • true:开启 IO 突发功能。
    • false:关闭 IO 突发功能。
    说明 了解通用云盘的 IO 突发功能的更多信息,请参见什么是通用云盘
    false
    AutoPayboolean

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

    • true:自动支付。您需要确保账户余额充足。
    • false:只生成订单不扣费。
    说明 默认值为 true。如果您的支付方式余额不足,可以将参数 AutoPay 设置为 false,此时会生成未支付订单,您可以登录 RDS 管理控制台自行支付。
    true
    IoAccelerationEnabledstring

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

    • 1:开启
    • 0:不开启
    说明 通用云盘的 IO 加速功能的更多信息,请参见通用云盘 IO 加速功能技术介绍
    0
    ColdDataEnabledboolean

    通用云盘数据归档功能开关。

    • true:开启。
    • false:关闭。
    说明 通用云盘的数据归档功能信息,请参见数据归档
    false
    WhitelistTemplateListstring

    白名单列表。 当需要配置多个 IP 地址时,用英文逗号隔开多个 IP 地址或 IP 段,且逗号前后不能有空格,例如192.168.0.1,172.16.213.9

    192.168.0.1,172.16.213.9
    AutoCreateProxyboolean

    是否自动创建代理。取值范围:

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

    • false:不开启自动创建。

    false

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    DryRunResultboolean

    创建实例预检查是否通过。返回值:

    • true:通过。
    • false:未通过。
    说明
  • 如不执行预检查,则不返回该参数。
  • 如预检查未通过,则返回对应错误。
  • true
    TagResultboolean

    实例是否成功绑定标签。返回值:

    • true:成功。
    • false:失败。
    说明 如不为实例绑定标签,则不返回该参数。
    true
    RequestIdstring

    请求 ID。

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

    实例内网连接地址。

    rm-uf6wjk5****.mysql.rds.aliyuncs.com
    Messagestring

    批量创建任务的提示信息。

    说明 该参数仅在 Amount 参数大于 1 时返回。
    Batch Create DBInstance Task Is In Process.
    DBInstanceIdstring

    实例 ID。若给 Amount 参数指定大于 1 的值, 将返回与该值对应的实例 ID 个数,以逗号分隔。

    例如 Amount 参数为 3,则返回 3 个实例 ID。示例: rm-uf6wjk5*****1,rm-uf6wjk5*****2,rm-uf6wjk5*****3

    rm-uf6wjk5****
    Portstring

    实例内网连接地址对应端口号。

    3306
    TaskIdstring

    批量创建任务的任务 ID。

    • 仅在 Amount 参数大于 1 时返回。
    • 当前暂不支持通过 TaskId 的值查看任务。
    s2365879-a9d0-55af-fgae-f2****
    DryRunboolean

    表示当前请求需要在创建实例前执行预检查。

    • 返回值固定为 true
    • 如不执行预检查,则不返回该参数。
    true
    OrderIdstring

    订单 ID。

    1007893702****
    说明 使用新版 SDK 包调用本接口时,由于 SDK 内部的客户端默认超时时间和服务端的不一致,因此可能返回请求超时的错误,但实际上接口已调用成功。如需避免这个问题,您可以在调用前设置 ReadTimeout 参数为 20000。 设置调用超时时间

    示例

    正常返回示例

    JSON格式

    {
      "DryRunResult": true,
      "TagResult": true,
      "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
      "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
      "Message": "Batch Create DBInstance Task Is In Process.",
      "DBInstanceId": "rm-uf6wjk5****",
      "Port": "3306",
      "TaskId": "s2365879-a9d0-55af-fgae-f2****",
      "DryRun": true,
      "OrderId": "1007893702****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400Invalid.ParamGroupDBVersion%s.%s-
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
    400RR309We have detected a security risk with your payment method. Please proceed with verification via the link in your email or console message and re-submit your order after verification.我们检测到您的付款方式存在安全风险。请通过电子邮件或控制台消息中的链接继续验证,并在验证后重新提交订单。
    400InvalidZoneId.NotSupportedThe Specified vpc Zone not supported.当前可用区不支持创建VPC网络类型实例,请更换可用区。
    400InvalidZone.NotSupportedForStorageTypeThe specified zone is closed or invalid for Specified DBInstanceStorageType.指定的区域已关闭或对于指定的DBInstanceStorageType无效。
    400InvalidNetworkTypeClassicWhenCloudStorageThe Specified InstanceNetworkType value Classic is not valid when choose cloud storage type.选择云存储类型时,指定 InstanceNetworkType 的值为 Classic 是无效的。
    400InvalidZone.NotSupportedThe Specified Zone not supported.区域无效。
    400InvalidEssdStorageSizeinvalid cloud essd storage size.云盘存储规格有误,请检查存储规格配置。
    400InvalidParameterSome Reuquest Parameters Is Invalid. Check or Try It Again Later.-
    400Pay.AmountLimitExceededPay amount limit exceeded.-
    400IncompleteAccountInfoYour information is incomplete. Complete your information before the operation.操作失败,账号信息中带*为必填项,请补充填写。路径:账号中心-基本信息。
    400IncompleteTaxInfoYour tax information is incomplete. Complete your information before the operation.操作失败,税务信息尚未完善。请补充信息。
    400InvalidPaymentMethod.IncompleteNo payment method is specified for your account. We recommend that you add a payment method.您的账户暂无有效支付方式,请添加支付方式。
    400InvalidPaymentMethod.MissingNo payment method is specified for your account. We recommend that you add a payment method.您的账户暂无有效支付方式,请添加支付方式。
    400InsuffcientBalanceOrBankAccountAdd a payment method or add funds to the prepayment balance. Get started by creating an instance.当前账户暂无有效支付方式,请添加支付方式或给预付款充值。
    400InvalidPaymentMethod.NoAccessNo payment method is specified for your account. We recommend that you add a payment method.-
    400InvalidPaymentMethod.InsufficientBalanceNo payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.-
    400Pay.LowFundsThe balance of the advance payment is insufficient or there is no balance of the advance payment.-
    400Pay.ChargeChannelNotFoundFailure to obtain the first external payment channel if the advance balance is insufficient.-
    400VswitchIpExhaustedVswitch IP exhausted.操作失败,vSwitch IP耗尽。
    400InvalidPrivateIpAddress.AlreadyUsedThe specified IP is already used.ip已被使用。
    400InvalidEcsImage.NotFoundSepcified ecs image does not exist-
    400InvalidMinorVersion.NotFoundSepcified minor version does not exists.-
    400InvalidConcurrentOperateConcurrent operation is detected.存在并发操作,请等待上一操作完成后再重试。
    400ZoneId.NotMatchWithCategoryThe number of ZoneId specified does not match with category.可用区数量与数据库类型或实例系列不匹配。请重新设置。
    400InvalidSecurityIPList.FormatThe specified parameter securityIPList is not valid.指定的安全IP列表格式不符合要求,请检查格式规范。
    400InvalidDBParamGroupId.FormatThe specified parameter dbParamGroupId is not valid.-
    400InvalidTargetMinorVersion.FormatThe specified parameter targetMinorVersion is not valid.-
    400InvalidDedicatedHostGroupId.FormatThe specified parameter dedicatedHostGroupId is not valid.-
    400InvalidDBInstanceClass.MalformedThe specified parameter DBInstanceClass is not valid.-
    400InvalidEngineVersion.MalformedThe specified parameter EngineVersion is not valid.数据库引擎版本无效,请确认后重试。
    400CreditPayInsufficientBalanceInsufficient credit pay limit. Please contact your channel partner to increase the limit.额度不足,请联系您的渠道合作伙伴提升额度。
    400InvalidTagKey.MalformedThe Tag.N.Key parameter is empty.Tag.N.Key参数为空
    400InvalidTagValue.MalformedThe Tag.N.Value parameter is empty.Tag.N.Value参数为空
    400Duplicate.TagKeyThe Tag.N.Key contains duplicate keys.Tag.N.Key包含重复键
    400NumberExceed.TagsThe maximum number of Tags is exceeded. The maximum is 20.标签参数数量超过限制,有效数量:20。
    400MissingParameter.ResourceIdsThe parameter ResourceIds.N must not be null.参数ResourceIds.N不能为空。
    400InvalidParameter.TagKeyThe Tag.N.Key parameter is invalid.Tag.N.Key参数无效.
    400InvalidParameter.TagValueThe Tag.N.Value parameter is invalid.Tag.N.Value参数无效。
    400NoPermission.SystemTagYou have no permission to use system tags.不能使用系统标签。
    400InvalidParam.AmountAmount is allowed from 1 to 20.数量支持1到20的数值。
    400InvalidParam.CreateStrategyOnly Atomicity and Partial are allowed.只支持Atomicity和Partial参数
    400InvalidParam.EngineOnly MySQL is allowed when Amount > 1.-
    400InvalidMultiZoneInfoListThe Specified Zone Info List is Invaild.-
    400InvalidKmsConfigStatusThe Kms Service Config is Invalid.-
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.链接地址名重复,请重新设置连接字符串。
    400InvalidPort.MalformedSpecified port is not valid.指定的端口无效。
    400InvalidUsedTimeUsedTime can not Less than or equal to zero.参数UsedTime不能小于或者等于0。
    400Kms.UnauthorizedKMS has not been authorized.KMS服务未授权。
    400InvalidDBInstanceClass.OfflineThe specified instance type is no longer provided. Please specify another instance type.当前所选的实例规格已下线,请更换其他实例规格。
    400SystemParamGroupCode.FormatSpecific DBParamGroupId is not valid.创建参数 DBParamGroupId 无效。
    400InvalidDBInstanceName.DuplicateSpecified DB instance name already exists in the Aliyun RDS.操作失败,实例名称已存在,请修改实例名称后重试。
    400ServiceLinkedRole.NotExistService linked role for RDS PostgreSQL not exist.请为RDS PostgreSQL授权服务关联角色AliyunServiceRoleForRdsPgsqlOnEcs
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
    400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
    400Price.CommoditySysCommodity system call exception.商品系统调用异常。
    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
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,该地域已裁撤。
    400InvalidPrivateIpAddress.FormatThe specified private IP address format is incorrect.指定的IP地址格式不正确。
    400InvalidPrivateIpAddress.MismatchSpecified private IP address is not in the CIDR block of virtual switch.VPC地址无效。
    400TooManyWhitelistTemplateIdscreate dbinstance can support attach to up to 10 whitelist templates.传入白名单模版数量过多!最多支持关联10个白名单模版
    400UnsupportExtendDisk.NotSupportSpecified DB instance is unsupport extend disk.指定的实例不支持扩展磁盘。
    400InvalidWhitelistTemplateIdthe template id list is invalid.传入的白名单模版ID列表有误,请检查!
    400InvalidRequestIdThe request is copy, check your token.重复请求,请检查token。
    400InvalidParameter.MinCapacityThe specified parameter 'MinCapacity' is not valid.入参“MinCapacity”无效。
    400InvalidUsedTimeThe usedTime value should be between 1 and 11.usedTime参数值应为1~11之间。
    400UnsupportedClassCodeThe specified DB instance class stops selling.实例规格停止售卖。
    400InvalidParameter.NotSupportDBInstanceStorageTypeParameter DBInstanceStorageType is invalid.DBInstanceStorageType参数无效
    400InvalidParam.InstanceNetworkTypeCreation of classic network instances is not supported.经典网络下线,不支持创建经典网络实例!
    400InvalidOrder.NotFoundSpecified order does not exist in RDS.RDS中不存在指定的订单。
    400InvalidVSwitchId.FormatThe specified vswitch Id format is incorrect.指定的vswitch Id格式不正确。
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    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,请先充值后再尝试购买。
    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.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
    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.您选购的服务存在未支付订单,请支付或作废后再下单。
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
    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。
    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.当前规格不支持此操作。
    400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
    400Parameters.InvalidParameter error, please check the parameters.参数错误,请检查参数。
    400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.数据归档不支持跨地域备份和秒级快照,请检查备份策略。
    400InvalideStatus.FormatThe instance status does not support this operation.实例状态不支持此操作。
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.实例释放后的归档备份保留策略无效。
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.DB实例引擎类型不支持此操作。
    400Pay.NoCreditCardNo credit cards.无信用卡。
    400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.vpc网络类型实例不支持此操作。
    400MirrorInsExistsSpecified DB instance mirror ins already existed.当前数据库实例镜像已存在。
    400InvalidBackupSetThe specified database does not exist in the backup set.备份集中没有指定的数据库。
    400OrdTCommodityQueryErrorFailed to query for product.查询产品失败。
    400ProductInstanceReleasedThe instance has been released. Please check before placing the order.实例已释放,请核实后下单。
    401CannotDecreaseEssdPerfLevelcannot decrease cloud essd performance level.存储类型变更校验失败,SQL Server云盘实例只能转为云盘,SSD只能升级到SSD或ESSD。
    403RISK.RISK_CONTROL_REJECTIONRisk control rejection.-
    403AliCroup2CloudUserCannotBuyNotInnerCommodityThere is no group cloud commodity label, and users within the group are not allowed to purchase.无集团上云商品标签,不允许集团内部用户购买。
    403GroupReplicationNotSupport.InvalidEngineVersionGroup Replication requires the instance engine version to be 8.0.实例数据库版本不是MySQL 8.0,不支持组复制。
    403GroupReplicationNotSupport.InvalidNodeClassCodeGroup Replication requires the ClassCode of each node to be consistent.实例各节点间规格不一致,不支持组复制。
    403GroupReplicationNotSupport.InvalidNodeNumGroup Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.实例节点个数不是大于等于3的单数,不支持组复制。
    403GroupReplicationNotSupport.InvalidXengineGroup Replication is not supported because the instance has xengine tables.实例存在xengine引擎表,不支持组复制。
    403GroupReplicationNotSupport.MemoryTooSmallGroup Replication is not supported because the memory is too small.实例规格内存太小,不支持组复制。
    403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
    403CloudDiskEncryptionNotSupportThe encryption key is not allowed for general-purpose instance.通用型规格实例不支持云盘加密。
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
    403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
    403BasicCategoryNotSupportThe Basic category is not supported.不支持基础版系列
    403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
    403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
    403OperationDenied.ZoneResourceThere is no available zone for inventory.没有可用的库存区域。
    403NotInFlowControllerSorry,no permission.非集团上云用户不可用,无权限。
    403InvalidKmsKeyKms key is disabled.Kms key已禁用。
    403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.当前数据库实例级别不支持此操作。
    403IncorrectCharacterTypeCurrent DB instance character type does not support this operation.当前实例字符类型不支持此操作。
    404InsufficientResourceCapacityThe target availability zone does not have sufficient resources.目标可用区没有足够的资源。
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
    404Request.NotFoundThe requested resource is not available.请求的资源不可用。
    404HostInfo.NotFoundThe specified host info is not found.指定的主机信息不存在。
    500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。
    500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.请求服务失败,请稍后再试或联系服务人员。
    500InvokeProxyFailureThe request processing has failed due to service failure of rds api.由于rds api服务失败,请求处理失败。

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

    变更历史

    变更时间变更内容概要操作
    2024-10-31OpenAPI 错误码发生变更查看变更详情
    2024-10-24OpenAPI 错误码发生变更查看变更详情
    2024-09-24OpenAPI 错误码发生变更查看变更详情
    2024-08-29OpenAPI 错误码发生变更查看变更详情
    2024-08-27OpenAPI 错误码发生变更查看变更详情
    2024-08-14OpenAPI 错误码发生变更查看变更详情
    2024-07-25OpenAPI 错误码发生变更查看变更详情
    2024-07-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2024-07-05OpenAPI 错误码发生变更查看变更详情
    2024-06-03OpenAPI 错误码发生变更查看变更详情
    2024-05-24OpenAPI 错误码发生变更查看变更详情
    2024-05-22OpenAPI 错误码发生变更查看变更详情
    2024-05-16OpenAPI 错误码发生变更查看变更详情
    2024-05-14OpenAPI 错误码发生变更查看变更详情
    2024-05-14OpenAPI 错误码发生变更查看变更详情
    2024-05-14OpenAPI 错误码发生变更查看变更详情
    2024-04-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2024-03-26OpenAPI 错误码发生变更查看变更详情
    2024-02-27OpenAPI 错误码发生变更查看变更详情
    2024-02-02OpenAPI 错误码发生变更查看变更详情