文档首页/ 云数据库 RDS/ API参考/ API v3/ 实例管理/ 创建数据库实例（v5接口） - CreateInstanceIam5
更新时间：2026-09-20 GMT+08:00
查看PDF
分享

创建数据库实例（v5接口） - CreateInstanceIam5

功能介绍

该接口由“创建数据库实例（v3）”接口派生而来，接口请求体新增了“subscription_agency”字段，该字段用于使用RAM共享密钥创建包周期RDS实例的场景。该接口用于创建RDS实例，可分为单实例、HA实例和只读副本。

本接口仅支持AK/SK认证。本接口支持在HTTP请求消息头中设置X-Client-Token请求头，保证请求幂等性。详细信息请参考请求幂等性说明。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:create

write

-

-

-

-

URI

  • URI格式

    POST /v5/{project_id}/instances

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

表2 参数说明（创建单机实例、主备实例和集群版实例）

名称

是否必选

参数类型

说明

name

是

String

参数解释：

实例名称。同一租户下，同类型的实例名可重名。

约束限制：

不涉及。

取值范围：

  • RDS for MySQL支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线、点或者下划线，不能包含其他的特殊字符。
  • RDS for PostgreSQL和RDS for SQL Server支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线或者下划线，不能包含其他的特殊字符。

默认取值：

不涉及。

datastore

否

Object

参数解释：

数据库信息。

详情请参见表4。

约束限制：

创建MySQL只读实例时该参数可选。

ha

否

Object

参数解释：

HA配置参数。

详情请参见表5。

约束限制：

创建主备实例时使用。

configuration_id

否

String

参数解释：

参数模板ID。

约束限制：

不涉及。

取值范围：

使用可参考获取参数模板列表 - ListConfigurations响应消息表3中的“id”。

默认取值：

不涉及。

port

否

String

参数解释：

数据库端口信息。

约束限制：

不涉及。

取值范围：

  • RDS for MySQL数据库端口设置范围为1024～65535（其中12017和33071被RDS系统占用不可设置）。
  • RDS for PostgreSQL数据库端口修改范围为2100～9500。
  • 对于RDS for SQL Server 2022 EE、2022 SE、2022 Web版、2019 EE、2019 SE、2019 Web版、2017 EE、2017 SE、2017 Web版：端口设置范围为1433和2100~9500（其中5050、5353、5355、5985和5986不可设置）。

    除此之外的其他版本：端口设置范围为1433和2100~9500（其中5355、5985和5986不可设置）。

默认取值：

当不传该参数时，默认端口如下：

  • RDS for MySQL默认3306。
  • RDS for PostgreSQL默认5432。
  • RDS for SQL Server默认1433。

password

否

String

参数解释：

数据库密码。

约束限制：

不涉及。

取值范围：

  • 对于RDS for MySQL实例，密码长度为8~32个字符，至少包含以下字符中的四种：大写字母、小写字母、数字和特殊字符 ~ ! @ # $ % ^ * - _ = + ? , ( ) & . |
  • 对于RDS for PostgreSQL实例，密码长度为8~32个字符，至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符 ~ ! @ # $ % ^ * - _ = + ? ,
  • 对于RDS for SQL Server实例，密码长度为8~32个字符，至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符 ~ ! @ # $ % ^ * - _ = + ? , . ( ) & |

建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您提供的密码被系统视为弱密码，您将收到错误提示，请提供更高强度的密码。

默认取值：

不涉及。

backup_strategy

否

Object

参数解释：

高级备份策略。

详情请参见表6。

约束限制：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

不涉及。

取值范围：

使用请参考《企业管理 API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。

默认取值：

不涉及。

disk_encryption_id

否

String

参数解释：

用于磁盘加密的密钥ID。

约束限制：

不涉及。

取值范围：

在密钥管理界面获取密钥ID。

默认取值：

默认为空。

subscription_agency

否

String

参数解释：

授权给Billing服务的委托URN。

约束限制：

使用RAM共享密钥创建包周期RDS实例时，需要传入该字段。

取值范围：

委托URN获取请参考获取委托URN。

默认取值：

默认为空。

flavor_ref

是

String

参数解释：

规格码。

约束限制：

不涉及。

取值范围：

非空，使用可参考查询数据库规格 - ListFlavors响应消息表3中的“spec_code”。

默认取值：

不涉及。

volume

是

Object

参数解释：

volume信息。

详情请参见表7。

约束限制：

不涉及。

region

是

String

参数解释：

区域ID。

约束限制：

不涉及。

取值范围：

非空，请参见地区和终端节点。

默认取值：

不涉及。

availability_zone

是

String

参数解释：

可用区ID。对于数据库实例类型不是单机的实例，需要分别为实例所有节点指定可用区，并用逗号隔开。详见示例。

调用查询数据库规格 - ListFlavors接口的返回信息中可以获取到可用区ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

vpc_id

否

String

参数解释：

虚拟私有云ID。

约束限制：

创建MySQL只读实例时该参数可选。

取值范围：

获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。
  • 方法2：获取方法请参见《虚拟私有云API参考》中“查询VPC列表”的内容。

默认取值：

不涉及。

subnet_id

否

String

参数解释：

子网的网络ID信息。

约束限制：

创建MySQL只读实例时该参数可选。

取值范围：

获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。
  • 方法2：获取方法请参见《虚拟私有云API参考》中“查询子网列表”的内容。

默认取值：

不涉及。

data_vip

否

String

参数解释：

指定实例的内网IP，目前仅支持设置IPv4地址。

约束限制：

不涉及。

取值范围：

获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找子网的网段，选择未被占用的IP 。
  • 方法2：获取方法请参见《虚拟私有云API参考》中“查询子网”的内容。

默认取值：

默认为空。

security_group_id

否

String

参数解释：

指定实例所属的安全组。

约束限制：

创建MySQL只读实例时该参数可选。

取值范围：

获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。
  • 方法2：获取方法请参见《虚拟私有云API参考》中“查询安全组列表”的内容。

默认取值：

不涉及。

charge_info

否

Object

参数解释：

计费类型信息，支持包周期和按需，默认为按需。

详情请参见表8。

约束限制：

不涉及。

time_zone

否

String

参数解释：

UTC时区。

约束限制：

不涉及。

取值范围：

MySQL和PostgreSQL引擎选择填写时，取值范围为UTC-12:00~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。

SQL Server引擎取值范围参见RDS for SQL Server时区与UTC偏移量对照表的时区列。

默认取值：

不选择时，各个引擎时区如下：
  • MySQL默认为UTC时间。
  • PostgreSQL默认为UTC时间。
  • SQL Server默认为UTC时间。

dsspool_id

否

String

参数解释：

Dec用户专属存储ID，每个az配置的专属存储不同，Dec用户创建实例时，对于数据库实例类型不是单机或只读的实例，需要分别为实例所有节点指定dsspoolId，并用逗号隔开。

约束限制：

不涉及。

取值范围：

获取方法如下：

  • 方法1：登录专属分布式存储服务DSS的控制台界面，查看专属存储列表，选择符合条件的az下的专属存储ID。
  • 方法2：通过专属分布式存储服务DSS的API接口查询，具体操作可参考获取专属存储详情列表。

默认取值：

不涉及。

replica_of_id

否

String

参数解释：

只读实例的主实例ID。

约束限制：

创建只读实例时必选，其它场景不可选。

取值范围：

不涉及。

默认取值：

不涉及。

restore_point

否

Object

参数解释：

恢复数据源对象。

详情请参见表10。

约束限制：

恢复到新实例时必选。

tags

否

Array of objects

参数解释：

标签列表，根据标签键值对创建实例。

  • {key}表示标签键，不可以为空或重复。
  • {value}表示标签值，可以为空。

如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含10组。

详情请参见 表9。

约束限制：

不涉及。

unchangeable_param

否

Object

参数解释：

不可变更参数列表。

详情参见表12。

约束限制：

该对象中的参数，在数据库初始化之前指定，指定后不支持修改。

collation

否

String

参数解释：

SQL Server实例字符集。

约束限制：

仅限RDS for SQL Server实例创建使用。对于RDS for MySQL和RDS for PostgreSQL实例，该参数无意义。

取值范围：

根据查询SQL Server可用字符集 - ListCollations查询可设置的字符集。

默认取值：

不涉及。

dry_run

否

Boolean

参数解释：

是否只预检此次请求。

约束限制：

仅支持MySQL引擎。

取值范围：

  • true：发送参数检查请求，不会创建实例。
    • 检查通过：返回202状态码。
    • 检查不通过：返回对应错误码，详情请参考错误码。
  • false：发送正常请求，通过检查后，并且执行创建实例的请求。

默认取值：

不涉及。

count

否

Integer

参数解释：

批量创建实例的数量。

约束限制：

仅创建RDS for MySQL和RDS for SQL Server主实例时，支持设置该参数。

创建只读实例时，不支持设置该参数。

取值范围：

1~50。

默认取值：

不涉及。

serverless_info

否

Object

参数解释：

Serverless型实例的资源扩缩范围。

详情参见表11 serverless_info字段数据结构说明。

约束限制：

创建Serverless型实例时必选。
表3 参数说明

名称

是否必选

参数类型

说明

name

是

String

参数解释：

实例名称。

用于表示实例的名称，同一租户下，同类型的实例名可重名。

约束限制：

不涉及。

取值范围：

  • RDS for MySQL支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线、点或者下划线，不能包含其他的特殊字符。
  • RDS for PostgreSQL和RDS for SQL Server支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线或者下划线，不能包含其他的特殊字符。

默认取值：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

不涉及。

取值范围：

该参数值可通过《企业管理 API参考》的“查询企业项目列表”中响应消息表“enterprise_project字段数据结构说明”的“id”获取。

默认取值：

不涉及。

disk_encryption_id

否

String

参数解释：

用于磁盘加密的密钥ID。

约束限制：

不涉及。

取值范围：

在密钥管理界面获取密钥ID。

默认取值：

默认为空。

subscription_agency

否

String

参数解释：

授权给Billing服务的委托URN。

约束限制：

使用RAM共享密钥创建包周期RDS实例时，需要传入该字段。

取值范围：

委托URN获取请参考获取委托URN。

默认取值：

不涉及。

replica_of_id

否

String

参数解释：

只读实例的主实例ID。

约束限制：

创建只读实例时必选，其它场景不可选。

取值范围：

不涉及。

默认取值：

不涉及。

flavor_ref

是

String

参数解释：

规格码。

约束限制：

不涉及。

取值范围：

非空，使用可参考查询数据库规格 - ListFlavors响应消息表3中的“spec_code”。

默认取值：

不涉及。

volume

是

Object

参数解释：

volume信息。

详情请参见表7。

约束限制：

不涉及。

region

否

String

参数解释：

区域ID。

约束限制：

当前只支持创建与主实例同region的只读实例。

取值范围：

非空，请参见地区和终端节点。

默认取值：

不涉及。

availability_zone

是

String

参数解释：

可用区ID。

约束限制：

不涉及。

取值范围：

调用查询数据库规格 - ListFlavors接口的返回信息中可以获取到可用区ID。

默认取值：

不涉及。

charge_info

否

Object

参数解释：

计费类型信息，支持包年/包月和按需，默认为按需。

详情请参见表8。

约束限制：

创建RDS for MySQL和RDS for PostgreSQL包年/包月计费模式的只读实例，需要具有相应的操作权限，您可以联系客服人员申请。

RDS for SQL Server暂时不支持包周期只读实例。
表4 datastore字段数据结构说明

名称

是否必选

参数类型

说明

type

是

String

参数解释：

数据库引擎。

约束限制：

不涉及。

取值范围：

  • MySQL
  • PostgreSQL
  • SQLServer

默认取值：

不涉及。

version

是

String

参数解释：

数据库版本。

约束限制：

不涉及。

取值范围：

  • MySQL引擎取值：5.7、8.0、8.4。
  • PostgreSQL引擎取值：13、14、15、16、17、18。9.5、9.6、10、11、12版本不支持购买，仅存量经营。
  • Microsoft SQL Server：仅支持2025 企业版、2025 标准版、2022 企业版、2022 标准版、2022 web版、2019 企业版、2019 标准版、2019 web版、2017 企业版、2017 标准版、2017 web版、2014 标准版、2014 企业版、2016 标准版、2016 企业版、2012 企业版、2012 标准版、2012 web版、2014 web版、2016 web版。取值示例2014_SE。2008 R2 企业版和2008 R2 web版不支持购买，仅存量经营。

数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。

默认取值：

不涉及。

complete_version

否

String

参数解释：

数据库完整版本号。

约束限制：

仅在数据库引擎是“PostgreSQL”时返回。

取值范围：

数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。

默认取值：

不涉及。
表5 ha字段数据结构说明

名称

是否必选

参数类型

说明

mode

是

String

参数解释：

实例主备模式。

约束限制：

不涉及。

取值范围：

HA，不区分大小写。

默认取值：

不涉及。

replication_mode

是

String

参数解释：

备机同步参数。

约束限制：

不涉及。

取值范围：

  • RDS for MySQL为“async”或“semisync”。
  • RDS for PostgreSQL为“async”或“sync”。
  • RDS for SQL Server为“sync”。
说明：
  • “async”为异步模式。
  • “semisync”为半同步模式。
  • “sync”为同步模式。

默认取值：

不涉及。
表6 backup_strategy字段数据结构说明

名称

是否必选

参数类型

说明

start_time

是

String

参数解释：

备份时间段。自动备份将在该时间段内触发。

约束限制：

不涉及。

取值范围：

非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。

  • HH取值必须比hh大1。
  • mm和MM取值必须相同，且取值必须为00、15、30或45。

取值示例：

  • 08:15-09:15
  • 23:00-00:00

默认取值：

不涉及。

keep_days

否

Integer

参数解释：

指定备份文件的可保留天数。

约束限制：

  • RDS for MySQL实例支持开启和关闭自动备份策略，并且开启后不支持关闭。
  • RDS for PostgreSQL实例支持开启和关闭自动备份策略，并且开启后不支持关闭。
  • RDS for SQL Server实例仅支持开启自动备份策略。

取值范围：

  • 对于RDS for MySQL实例，支持0～732天。取值为0，表示关闭自动备份策略。如果需要延长保留时间请提交工单申请，自动备份最长可以保留10年。
  • 对于RDS for PostgreSQL实例，支持0~3660天。取值为0，表示关闭自动备份策略。
  • 对于RDS for SQL Server实例，支持1～732天。如果需要延长保留时间请提交工单申请，自动备份最长可以保留10年。

默认取值：

  • 对于RDS for MySQL实例，该参数缺省时默认为0。
  • 对于RDS for PostgreSQL实例，该参数缺省时默认为0。
  • 对于RDS for SQL Server实例，该参数缺省时默认保留7天。
表7 volume字段数据结构说明

名称

是否必选

参数类型

说明

type

是

String

参数解释：

磁盘类型。

约束限制：

不涉及。

取值范围：

取值如下，区分大小写：

  • ULTRAHIGH，表示超高IO型磁盘。
  • CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。
  • ESSD，表示极速型SSD。
  • ESSD2，表示极速型SSD V2。

默认取值：

不涉及。

size

否

Integer

参数解释：

磁盘大小。

约束限制：

对于只读实例，该参数无效，磁盘大小，默认和主实例相同。

取值范围：

  • 对于MySQL引擎：20GB~10000GB，必须为10的整数倍。
  • 对于PostgreSQL引擎：40GB~4000GB，必须为10的整数倍。
  • 对于SQL Server引擎：40GB~10000GB，必须为10的整数倍。

默认取值：

不涉及。
表8 charge_info字段数据结构说明

名称

是否必选

参数类型

说明

charge_mode

是

String

参数解释：

计费模式。

约束限制：

不涉及。

取值范围：

  • prePaid：预付费，即包年/包月。
  • postPaid：后付费，即按需付费。

默认取值：

不涉及。

period_type

否

String

参数解释：

订购周期类型。

约束限制：

“charge_mode”为“prePaid”时生效，且为必选值。

取值范围：

  • month：包月。
  • year：包年。

默认取值：

不涉及。

period_num

否

Integer

参数解释：

订购时长。

约束限制：

“charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。

取值范围：

  • 当“period_type”为“month”时，取值为1~9。
  • 当“period_type”为“year”时，取值为1~3和5。

    当前仅RDS for MySQL支持订购时间设置为5年，约束条件如下：

    • 如需订购时间设置为5年，需要具有相应的操作权限，您可以联系客服人员申请。
    • 当前仅华北-北京四、华东-上海一、华南-广州、西南-贵阳一支持。
    • 当前仅通用型规格实例支持。

默认取值：

不涉及。

is_auto_renew

否

boolean

参数解释：

创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

约束限制：

不涉及。

取值范围：

  • true，为自动续订。
  • false，为不自动续订。

默认取值：

false

is_auto_pay

否

boolean

参数解释：

创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。

约束限制：

不涉及。

取值范围：

  • true，为自动支付。
  • false，为手动支付。

默认取值：

false
表9 tags字段数据结构说明

名称

是否必选

参数类型

说明

key

是

String

参数解释：

标签键。

约束限制：

不涉及。

取值范围：

长度为1-128个unicode字符。

可以包含任何语种字母、数字、空格和_.:=+-@()，但首尾不能含有空格，不能以_sys_开头。

默认取值：

不涉及。

value

是

String

参数解释：

标签值。

约束限制：

不涉及。

取值范围：

最大长度255个unicode字符，可以为空字符串。

可以包含任何语种字母、数字、空格和_.:=+-@()。

默认取值：

不涉及。
表10 restore_point字段数据结构说明

名称

是否必选

参数类型

说明

instance_id

是

String

参数解释：

源实例ID。

约束限制：

不涉及。

取值范围：

该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

默认取值：

不涉及。

type

是

String

参数解释：

表示恢复方式。

约束限制：

不涉及。

取值范围：

  • “backup”，表示使用备份文件恢复，按照此方式恢复时，“type”字段为非必选，“backup_id”必选。
  • “timestamp”，表示按时间点恢复，按照此方式恢复时，“type”字段必选，“restore_time”必选。

默认取值：

不涉及。

backup_id

否

String

参数解释：

用于恢复的备份ID。

约束限制：

当使用备份文件恢复时需要指定该参数。

取值范围：

该参数值可调用获取备份列表接口，通过表3中的“id”获取。

默认取值：

不涉及。

restore_time

否

Integer

参数解释：

恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

database_name

否

Map<String,String>

参数解释：

数据库名称。

约束限制：

  • 仅适用于SQL Server引擎，当有此参数时表示支持局部恢复和重命名恢复，恢复数据以局部恢复为主。
  • 新数据库名称不可与源实例数据库名称重名，新数据库名称为空，默认按照原数据库名进行恢复。 注意： 不填写该字段时，默认恢复全部数据库。

    示例："database_name": {"原库名":"新库名"}

  • 新数据库名不能包含rdsadmin、master、msdb、tempdb、model或resource字段（不区分大小写）。
  • 数据库名称长度在1~64个字符之间，包含字母、数字、下划线或中划线，不能包含其他特殊字符。
表11 serverless_info字段数据结构说明

名称

是否必选

参数类型

说明

min_cap

是

String

参数解释：

Serverless型实例的最小算力，单位RCU。

说明：

RCU即RDS Capacity Unit，是Serverless型实例的计费单位。

约束限制：

max_cap的值要大于min_cap的值。

取值范围：

范围0.5~8，步进0.5。

默认取值：

不涉及。

max_cap

是

String

参数解释：

Serverless型实例的最大算力，单位RCU。

约束限制：

max_cap的值要大于min_cap的值。

取值范围：

范围0.5~8，步进0.5。

默认取值：

不涉及。
表12 unchangeable_param字段数据结构说明

名称

是否必选

参数类型

说明

lower_case_table_names

否

String

参数解释：

表名大小写是否敏感。

约束限制：

恢复已有实例时，目标实例与原实例表名大小写设置不一致，可能会导致恢复失败。

取值范围：

  • 0：表名被存储成固定且表名称大小写敏感。
  • 1：表名将被存储成小写且表名称大小写不敏感。

默认取值：

1

请求样例中参数“region”和“availability_zone”的值为示例值。

  • URI样例

    POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances

  • 请求样例

    使用RAM共享密钥创建包周期MySQL单机实例：

    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "MySQL",
		"version": "5.7"
	},
	"flavor_ref": "rds.mysql.s1.large",
	"volume": {
		"type": "ULTRAHIGH",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"subscription_agency": "xxx::xxxxx:xx:xxxx",
	"region": "ap-southeast-1",
	"availability_zone": "ap-southeast-1a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.147",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
        "charge_info": {
		"charge_mode": "prePaid",
                "period_type": "year",
                "period_num": 1
        },
	"password": "Test@12345678",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "UTC+04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	],
        "dry_run": false,
        "count": 12
}

    使用RAM共享密钥创建包周期PostgreSQL单机实例：

    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "PostgreSQL",
		"version": "10"
	},
	"flavor_ref": "rds.pg.s1.large",
	"volume": {
		"type": "ULTRAHIGH",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
        "subscription_agency": "xxx::xxxxx:xx:xxxx",
	"region": "ap-southeast-1",
	"availability_zone": "ap-southeast-1a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.147",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
        "charge_info": {
		"charge_mode": "prePaid",
                "period_type": "year",
                "period_num": 1
	},
	"password": "Test@12345678",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "UTC+04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	]
}

    使用RAM共享密钥创建包周期SQL Server单机实例

    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "SQLServer",
		"version": "2014_SE"
	},
	"flavor_ref": "rds.mssql.se.m3.large.8",
	"volume": {
		"type": "ULTRAHIGH",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
        "subscription_agency": "xxx::xxxxx:xx:xxxx",
	"region": "ap-southeast-1",
	"availability_zone": "ap-southeast-1a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.147",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
        "charge_info": {
		"charge_mode": "prePaid",
                "period_type": "year",
                "period_num": 1
	},
        "collation": "Cyrillic_General_CI_AS",
	"password": "Test@12345678",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "UTC+04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	]
}

    使用RAM共享密钥创建包周期MySQL主备实例：

    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "MySQL",
		"version": "5.7"
	},
	"ha": {
		"mode": "ha",
		"replication_mode": "semisync"
	},
	"flavor_ref": "rds.mysql.s1.large.ha",
	"volume": {
		"type": "ULTRAHIGH",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
        "subscription_agency": "xxx::xxxxx:xx:xxxx",
	"region": "ap-southeast-1",
	"availability_zone": "ap-southeast-1a,ap-southeast-1b",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.147",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
        "charge_info": {
		"charge_mode": "prePaid",
                "period_type": "year",
                "period_num": 1
	},
	"password": "Test@12345678",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "UTC+04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	],
        "dry_run": false,
        "count": 12
}

    使用RAM共享密钥创建包周期MySQL只读实例：

    {
	"name": "rds-instance-rep2",
	"replica_of_id": "afdsad-fds-fdsagin01",
	"flavor_ref": "rds.mysql.s1.large.rr",
	"volume": {
		"type": "ULTRAHIGH"
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"subscription_agency": "xxx::xxxxx:xx:xxxx",
        "region": "ap-southeast-1",
	"availability_zone": "ap-southeast-1a",

        "charge_info": {
		"charge_mode": "prePaid",
                "period_type": "year",
                "period_num": 1
	},
	"enterprise_project_id": "fdsa-3rds",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	]
}

响应消息

  • 正常响应要素说明
    表13 要素说明

    名称

    参数类型

    说明

    instance

    Object

    参数解释：

    实例信息。

    详情请参见表14。

    job_id

    String

    参数解释：

    实例创建的任务id。

    查询详细任务信息请参见获取指定ID的任务信息 - ListJobInfo。

    仅创建按需实例时会返回该参数。

    取值范围：

    不涉及。

    order_id

    String

    参数解释：

    订单号，创建包周期实例时返回该参数。

    取值范围：

    不涉及。
    表14 instance说明

    名称

    参数类型

    说明

    id

    String

    参数解释：

    实例ID，批量创建实例时，MySQL返回字段为多个实例ID以英文逗号（,）隔开，其他引擎该字段为空。

    取值范围：

    不涉及。

    name

    String

    参数解释：

    实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。

    取值范围：

    不涉及。

    status

    String

    参数解释：

    实例状态。

    取值范围：

    如BUILD，表示创建中。

    仅创建按需实例时会返回该参数。

    datastore

    Object

    参数解释：

    数据库信息。

    详情请参见表15。

    ha

    Object

    参数解释：

    HA配置参数，仅当您选择创建HA实例时该参数才可见。

    详情请参见表16。

    configuration_id

    String

    参数解释：

    参数模板ID，仅当您创建实例指定用户自定义参数组时，该参数才可见。

    取值范围：

    不涉及。

    port

    String

    参数解释：

    数据库端口信息。

    取值范围：

    与请求参数相同。

    backup_strategy

    Object

    参数解释：

    自动备份策略。

    详情请参见表17。

    enterprise_project_id

    String

    参数解释：

    项目标签。

    取值范围：

    不涉及。

    disk_encryption_id

    String

    参数解释：

    用于磁盘加密的密钥ID。

    取值范围：

    仅当您创建实例选择该参数时才可见，默认为空。

    flavor_ref

    String

    参数解释：

    规格码。

    取值范围：

    非空，使用可参考查询数据库规格 - ListFlavors响应消息表3中的“spec_code”。

    volume

    Object

    参数解释：

    volume信息。

    详情请参见表18。

    region

    String

    参数解释：

    区域ID。

    取值范围：

    不涉及。

    availability_zone

    String

    参数解释：

    可用区ID。

    取值范围：

    不涉及。

    vpc_id

    String

    参数解释：

    虚拟私有云ID。

    取值范围：

    不涉及。

    subnet_id

    String

    参数解释：

    子网的网络ID信息。

    取值范围：

    不涉及。

    security_group_id

    String

    参数解释：

    指定实例所属的安全组。

    取值范围：

    不涉及。

    charge_info

    Object

    参数解释：

    计费方式信息，支持包年/包月和按需。

    详情请参见表19。

    collation

    String

    参数解释：

    RDS for SQL Server设定的字符集信息。

    取值范围：

    不涉及。

    restore_point

    Object

    参数解释：

    恢复数据源对象。恢复到新实例时必选。

    详情请参见表20。
    表15 datastore字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    参数解释：

    数据库引擎。

    取值范围：

    • MySQL
    • PostgreSQL
    • SQLServer

    version

    String

    参数解释：

    数据库版本。

    取值范围：

    数据库支持的详细版本信息，可调用查询数据库引擎的版本 - ListDatastores接口获取。

    complete_version

    String

    数据库完整版本号。
    表16 ha字段数据结构说明

    名称

    参数类型

    说明

    mode

    String

    参数解释：

    实例主备模式。

    取值范围：

    Ha

    replication_mode

    String

    参数解释：

    备机同步参数。实例为Ha模式时有效。

    取值范围：

    • RDS for MySQL为“async”或“semisync”。
    • RDS for PostgreSQL为“async”或“sync”。
    • RDS for SQL Server为“sync”。
    说明：
    • “async”为异步模式。
    • “semisync”为半同步模式。
    • “sync”为同步模式。
    表17 backupStrategy字段数据结构说明

    名称

    参数类型

    说明

    start_time

    String

    参数解释：

    备份时间段。自动备份将在该时间段内触发。

    取值范围：

    非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。

    • HH取值必须比hh大1。
    • mm和MM取值必须相同，且取值必须为00、15、30或45。

    取值示例：

    • 08:15-09:15
    • 23:00-00:00

    如果请求体中“backup_strategy”为空，则响应体中 “start_time”默认返回“02:00-03:00”。

    keep_days

    Integer

    参数解释：

    指定备份文件的可保留天数。

    取值范围：

    • 对于RDS for MySQL实例，支持0～732天。取值为0，表示关闭自动备份策略。如果需要延长保留时间请提交工单申请，自动备份最长可以保留10年。
    • 对于RDS for PostgreSQL实例，支持0~3660天。取值为0，表示关闭自动备份策略。
    • 对于RDS for SQL Server实例，支持1～732天。如果需要延长保留时间请提交工单申请，自动备份最长可以保留10年。
    表18 volume字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    参数解释：

    磁盘类型。

    取值范围：

    区分大小写。

    • ULTRAHIGH，表示超高IO型磁盘。
    • CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。
    • ESSD，表示极速型SSD。

    size

    Integer

    参数解释：

    磁盘大小。

    取值范围：

    • 对于MySQL引擎：20GB~10000GB，必须为10的整数倍。
    • 对于PostgreSQL引擎：40GB~4000GB，必须为10的整数倍。
    • 对于SQL Server引擎：40GB~10000GB，必须为10的整数倍。
    表19 chargeInfo字段数据结构说明

    名称

    参数类型

    说明

    charge_mode

    String

    参数解释：

    创建类型，支持包年/包月和按需。

    取值范围：

    不涉及。

    period_type

    String

    参数解释：

    订购周期类型。

    取值范围：

    • month：包月。
    • year：包年。

    period_num

    Integer

    参数解释：

    订购周期长度，按月计算。

    “charge_mode”为“prePaid”，即包年/包月时该字段生效。

    取值范围：

    不涉及。

    is_auto_pay

    Boolean

    参数解释：

    创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。

    取值范围：

    • false：手动支付，默认该方式。
    • true：自动支付。

    is_auto_renew

    Boolean

    参数解释：

    创建包周期实例时指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

    取值范围：

    • false：不自动续订，默认该方式。
    • true：自动续订。
    表20 restore_point字段数据结构说明

    参数

    参数类型

    描述

    instance_id

    String

    参数解释：

    源实例ID。

    取值范围：

    不涉及。

    type

    String

    参数解释：

    恢复方式。

    取值范围：

    • backup：表示使用备份文件恢复。
    • timestamp：表示按时间点恢复。

    backup_id

    String

    参数解释：

    用于恢复的备份ID。

    取值范围：

    不涉及。

    restore_time

    Integer

    参数解释：

    恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。

    取值范围：

    不涉及。

    database_name

    Map<String,String>

    参数解释：

    仅适用于SQL Server引擎，当有此参数时表示支持局部恢复和重命名恢复，恢复数据以局部恢复为主。

    取值范围：

    不涉及。

响应样例中参数“region”和“availability_zone”的值为示例值。

  • 正常响应样例

    MySQL单机实例：

    {
	"instance": {
		"id": "dsfae23fsfdsae3435in01",
		"name": "trove-instance-rep2",
		"datastore": {
			"type": "MySQL",
			"version": "5.7"
		},
		"flavor_ref": "rds.mysql.s1.large",
		"volume": {
			"type": "ULTRAHIGH",
			"size": 100
		},
		"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
                "region": "ap-southeast-1",
	        "availability_zone": "ap-southeast-1a",
		"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
		"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
		"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
		"port": "8635",
		"backup_strategy": {
			"start_time": "08:15-09:15",
			"keep_days": 3
		},
		"configuration_id": "452408-44c5-94be-305145fg",
                "charge_info": {
		        "charge_mode": "prePaid",
                        "period_type": "year",
                        "period_num": 1
		},
	},
	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

    SQL Server单机实例：

    {
	"instance": {
		"id": "dsfae23fsfdsae3435in01",
		"name": "trove-instance-rep2",
		"datastore": {
			"type": "sqlserver",
			"version": "2014_SE"
		},
		"flavor_ref": "rds.mssql.2014.se.s3.large.2",
		"volume": {
			"type": "ULTRAHIGH",
			"size": 100
		},
		"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
                "region": "ap-southeast-1",
	        "availability_zone": "ap-southeast-1a",
		"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
		"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
		"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
		"port": "8635",
		"backup_strategy": {
			"start_time": "08:15-09:15",
			"keep_days": 3
		},
		"configuration_id": "452408-44c5-94be-305145fg",
                "charge_info": {
		        "charge_mode": "prePaid",
                        "period_type": "year",
                        "period_num": 1
		},
               "collation": "Cyrillic_General_CI_AS" 
	},
	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

    MySQL主备实例：

    {
  "instance":{ 
           "id": "dsfae23fsfdsae3435in01",
           "name": "trove-instance-rep2", 
           "datastore": { 
             "type": "MySQL", 
             "version": "5.7" 
            }, 
           "ha": {
             "mode": "ha",
             "replication_mode": "semisync"
           },
           "flavor_ref": "rds.mysql.s1.large.ha",
           "volume": { 
               "type": "ULTRAHIGH", 
               "size": 100 
             },
           "disk_encryption_id":  "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
           "region": "ap-southeast-1",
	   "availability_zone": "ap-southeast-1a,ap-southeast-1b",
           "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", 
           "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
           "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", 
           "port": "8635", 
           "backup_strategy": { 
             "start_time": "08:15-09:15", 
             "keep_days": 3 
            }, 
           "configuration_id": "452408-44c5-94be-305145fg",
           "charge_info": {
		"charge_mode": "prePaid",
                "period_type": "year",
                "period_num": 1
	   },
         },
  "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" 
}

    MySQL只读实例：

    {
  "instance":{ 
            "id": "dsfae23fsfdsae3435in01",
            "name": "trove-instance-rep2", 
            "flavor_ref": "rds.mysql.s1.large.rr",
             "volume": { 
               "type": "ULTRAHIGH", 
               "size": 100 
             },
           "disk_encryption_id":  "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
           "region": "ap-southeast-1",
	   "availability_zone": "ap-southeast-1a",
           "charge_info": {
		"charge_mode": "prePaid",
                "period_type": "year",
                "period_num": 1
	   },
           "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", 
           "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
           "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", 
           "port": "8635", 
           "configuration_id": "452408-44c5-94be-305145fg"
         },
 "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"  
}
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

获取委托URN

  1. 打开统一身份认证服务（IAM）管理控制台。
    图1 IAM页面
  2. 选择“委托 > 创建委托”。
  3. 在创建委托页面，填选如下内容，单击“完成”，在弹框中单击“立即授权”。
    • 委托名称：例如agency_billing
    • 委托类型：云服务
    • 云服务：Billing
    • 持续时间：永久
    • 描述：委托的描述
    图2 创建委托
  4. 搜索框输入“fulfillment”进行搜索，勾选“ServicePolicyForRDSFulfillment”，单击“下一步”。

    使用RAM KMS共享密钥创建包周期RDS实例时，必须委托账号内资源的操作权限给Billing服务，并授予ServicePolicyForRDSFulfillment权限，授权成功后，Billing服务将获取KMS密钥用于创建加密磁盘。

    图3 选择策略
  5. 默认授权所有资源，单击“确定”，完成委托创建。
    图4 选择授权范围
  6. 单击创建完成的委托名称，在基本信息页，获取委托URN。
    图5 获取URN
父主题： 实例管理