创建数据库实例
功能介绍
创建RDS实例，可分为单机实例、主备实例和只读实例。
- 调用接口前，您需要了解API认证鉴权。
- 调用接口前，您需要了解请求Header参数说明。
本接口支持创建RDS for MySQL实例时，在HTTP请求消息头中设置X-Client-Token请求头，保证请求幂等性。详细信息请参考请求幂等性说明。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
请求消息
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
name |
是 |
String |
实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。取值规则如下：
|
|
datastore |
是 |
Object |
数据库信息。 详情请参见表4。 |
|
flavor_ref |
是 |
String |
规格码，取值范围：非空。 |
|
volume |
是 |
Object |
实例存储信息。 详情请参见表7。 |
|
region |
是 |
String |
区域ID。 取值范围：非空，请参见地区和终端节点。 |
|
availability_zone |
是 |
String |
可用区ID。对于数据库实例类型不是单机的实例，需要分别为实例所有节点指定可用区，并用逗号隔开。详见示例。 调用查询数据库规格接口的返回信息中可以获取到可用区ID。 |
|
vpc_id |
是 |
String |
虚拟私有云ID，获取方法如下：
|
|
subnet_id |
是 |
String |
子网的网络ID信息，获取方法如下：
|
|
security_group_id |
是 |
String |
指定实例所属的安全组。
如需开通MySQL多安全组权限，您可以提交工单申请。最多支持添加10个安全组ID，安全组ID之间用英文逗号隔开。 |
|
ha |
否 |
Object |
HA配置参数，创建主备实例时使用。 详情请参见表5。 |
|
configuration_id |
否 |
String |
参数模板ID。 |
|
port |
否 |
String |
数据库端口信息。
当不传该参数时，默认端口如下：
|
|
password |
否 |
String |
数据库密码。 取值范围： 数据库支持的密码长度是8~32个字符，至少包含大写字母、小写字母、数字、特殊字符三种字符的组合。 其中允许的特殊字符如下：
建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您提供的密码被系统视为弱密码，您将收到错误提示，请提供更高强度的密码。 |
|
backup_strategy |
否 |
Object |
高级备份策略。 详情请参见表6。 |
|
enterprise_project_id |
否 |
String |
企业项目ID。 使用请参考《企业管理 API参考》的“查询企业项目列表”响应消息表“enterprise_project字段数据结构说明”的“id”。 |
|
disk_encryption_id |
否 |
String |
用于磁盘加密的密钥ID，默认为空。
说明：
Serverless型实例不支持该参数。 |
|
data_vip |
否 |
String |
指定实例的内网IP，目前仅支持设置IPv4地址，获取方法如下：
|
|
charge_info |
否 |
Object |
计费类型信息，支持包年包月和按需，默认为按需。 详情请参见表8。 |
|
time_zone |
否 |
String |
UTC时区。
|
|
dsspool_id |
否 |
String |
Dec用户专属存储ID，每个az配置的专属存储不同，Dec用户创建实例时，对于数据库实例类型不是单机或只读的实例，需要分别为实例所有节点指定dsspoolId，并用逗号隔开。 |
|
restore_point |
否 |
Object |
恢复数据源对象。恢复到新实例时必选。 详情请参见表10。 |
|
tags |
否 |
Array of objects |
标签列表，根据标签键值对创建实例。
如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含20组。 详情请参见 表9。 |
|
unchangeable_param |
否 |
Object |
不可变更参数列表。该对象中的参数，在数据库初始化之前指定，指定后不支持修改。 详情参见表12。 |
|
collation |
否 |
String |
仅限RDS for SQL Server实例创建使用。对于RDS for MySQL和RDS for PostgreSQL实例，该参数无意义。 取值范围：根据查询SQL Server可用字符集查询可设置的字符集。 |
|
dry_run |
否 |
Boolean |
是否只预检此次请求，仅支持MySQL引擎。
|
|
count |
否 |
Integer |
批量创建实例的数量，取值范围为1~50。 创建只读实例时，不支持设置该参数。 |
|
serverless_info |
否 |
Object |
Serverless型实例的资源扩缩范围。创建Serverless型实例时必选。 |
|
is_auto_upgrade |
否 |
Boolean |
参数解释： 是否开启自动小版本升级。 约束限制： 仅支持RDS for PostgreSQL实例。 取值范围：
默认取值： false |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
name |
是 |
String |
实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。 取值规则如下：
|
|
replica_of_id |
是 |
String |
只读实例的主实例ID。创建只读实例时必选，其它场景不可选。 |
|
flavor_ref |
是 |
String |
规格码，取值范围：非空。 |
|
volume |
是 |
Object |
volume信息。 详情请参见表7。 |
|
availability_zone |
是 |
String |
可用区ID。 调用查询数据库规格接口的返回信息中可以获取到可用区ID。 |
|
enterprise_project_id |
否 |
String |
项目标签。 |
|
disk_encryption_id |
否 |
String |
用于磁盘加密的密钥ID，默认为空。 |
|
region |
否 |
String |
区域ID。当前只支持创建与主实例同region的只读实例。 取值范围：非空，请参见地区和终端节点。 |
|
charge_info |
否 |
Object |
计费类型信息，支持包年/包月和按需，默认为按需。 详情请参见表8。
说明：
创建RDS for MySQL和RDS for PostgreSQL包年/包月计费模式的只读实例，需要具有相应的操作权限，您可以联系客服人员申请。 RDS for SQL Server暂时不支持包周期只读实例。 |
|
dsspool_id |
否 |
String |
Dec用户专属存储ID，每个az配置的专属存储不同，Dec用户创建实例时，对于数据库实例类型不是单机或只读的实例，需要分别为实例所有节点指定dsspoolId，并用逗号隔开。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
type |
是 |
String |
数据库引擎，取值如下：
|
|
version |
是 |
String |
数据库版本。
数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 |
|
complete_version |
否 |
String |
数据库完整版本号。仅在数据库引擎是“PostgreSQL”时返回。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
mode |
是 |
String |
实例主备模式，取值：HA，不区分大小写。 |
|
replication_mode |
是 |
String |
备机同步参数。 取值：
说明：
|
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
start_time |
是 |
String |
备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。
取值示例：
|
|
keep_days |
否 |
Integer |
指定备份文件的可保存天数。 取值范围：0～732。该参数缺省，或取值为0，表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。
须知：
RDS for SQL Server的HA实例不支持关闭自动备份策略。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
type |
是 |
String |
磁盘类型。 取值范围如下，区分大小写：
|
|
size |
是 |
Integer |
磁盘大小。 取值范围：40GB~4000GB，必须为10的整数倍。
说明：
对于只读实例，该参数无效，磁盘大小，默认和主实例相同。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
charge_mode |
是 |
String |
计费模式。 取值范围：
|
|
period_type |
否 |
String |
订购周期类型。 取值范围：
|
|
period_num |
否 |
Integer |
“charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围：
|
|
is_auto_renew |
否 |
boolean |
创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。
|
|
is_auto_pay |
否 |
boolean |
创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
key |
是 |
String |
标签键。长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@，但首尾不能含有空格，不能以_sys_开头。 |
|
value |
是 |
String |
标签值。最大长度255个unicode字符，可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
instance_id |
是 |
String |
源实例ID。 |
|
type |
是 |
String |
表示恢复方式，枚举值：
|
|
backup_id |
否 |
String |
用于恢复的备份ID。当使用备份文件恢复时需要指定该参数。 |
|
restore_time |
否 |
Integer |
恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。 |
|
database_name |
否 |
Map<String,String> |
仅适用于SQL Server引擎，当有此参数时表示支持局部恢复和重命名恢复，恢复数据以局部恢复为主。 |
请求示例
- 创建MySQL单机实例。
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances { "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "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": "postPaid" }, "password": "****", "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 } - 创建PostgreSQL单机实例。
{ "name": "rds-instance-rep2", "datastore": { "type": "PostgreSQL", "version": "10" }, "flavor_ref": "rds.pg.s1.large", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "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": "postPaid" }, "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" } ] }
- 创建MySQL 8.0单机实例指定初始化参数。
{ "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "8.0" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "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": "postPaid" }, "password": "****", "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" } ], "unchangeable_param": { "lower_case_table_names": "1" }, "dry_run": false, "count": 12 }
- 创建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", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "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": "postPaid" }, "collation": "Cyrillic_General_CI_AS", "password": "****", "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" } ], }
- DeC用户创建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", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "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": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "dsspool_id":"3278327382738217382173872183721837213", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 12 }
- 创建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": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a,cn-north-4b", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "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": "postPaid" }, "password": "****", "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 }
- DeC用户创建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", "region": "cn-north-4", "availability_zone": "cn-north-4a,cn-north-4b", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "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": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "dsspool_id":"327832738273821772133432，21489938273821772133432", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 12 }
- 创建MySQL只读实例。
{ "name": "rds-instance-rep2", "replica_of_id": "afdsad-fds-fdsagin01", "flavor_ref": "rds.mysql.s1.large.rr", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "enterprise_project_id": "fdsa-3rds", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }
- DeC用户创建只读实例。
{ "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", "region": "cn-north-4", "availability_zone": "cn-north-4a", "enterprise_project_id": "fdsa-3rds" "dsspool_id":"3278327382738217382173872183721837213", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] - 创建MySQL Serverless型单机实例。
{ "name": "rds-instance-serverless1", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.serverless", "volume": { "type": "CLOUDSSD", "size": 40 }, "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 3306, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "password": "****", "time_zone": "UTC+04:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 1, "serverless_info": { "min_cap": "0.5", "max_cap": "1" } } - 创建MySQL Serverless型主备实例。
{ "name": "rds-instance-serverless2", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.serverless.ha", "volume": { "type": "CLOUDSSD", "size": 40 }, "region": "cn-north-4", "availability_zone": "cn-north-4a,cn-north-4b", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port":3306, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "password": "****", "time_zone": "UTC+08:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 1, "serverless_info": { "min_cap": "0.5", "max_cap": "1" } }
响应消息
- 正常响应要素说明
表13 要素说明 名称
参数类型
说明
instance
Object
实例信息。
详情请参见表14。
job_id
String
实例创建的任务id。
查询详细任务信息请参见获取指定ID的任务信息。
仅创建按需实例时会返回该参数。
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，仅当您创建实例选择该参数时才可见，默认为空。
说明：Serverless型实例不支持该参数。
flavor_ref
String
规格码，取值范围：非空。
volume
Object
volume信息。
详情请参见表18。
region
String
区域ID。
availability_zone
String
可用区ID。
vpc_id
String
虚拟私有云ID，获取方法如下：
- 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。
- 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。
subnet_id
String
子网的网络ID信息，获取方法如下：
- 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。
- 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。
security_group_id
String
指定实例所属的安全组。
- 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。
- 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。
charge_info
Object
计费方式信息，支持包年/包月和按需。
详情请参见表19。
collation
String
RDS for SQL Server设定的字符集信息。
restore_point
Object
恢复数据源对象。恢复到新实例时必选。
详情请参见表20。
表15 datastore字段数据结构说明 名称
参数类型
说明
type
String
数据库引擎，返回值如下：
- MySQL
- PostgreSQL
- SQLServer
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
指定已生成备份文件的可保存天数。
取值范围：0～732。该参数缺省，或取0值，表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。
如果请求体中“backup_strategy”为空，则响应体中 “keep_days”默认返回“7”。
表18 volume字段数据结构说明 名称
参数类型
说明
type
String
磁盘类型。
取值范围如下，区分大小写：
- ULTRAHIGH，表示超高IO型磁盘。
- LOCALSSD，表示本地SSD盘。
- CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。
- ESSD，表示极速型SSD。
size
Integer
磁盘大小。
取值范围：40GB~4000GB。必须为10的整数倍。
响应样例中参数“region”和“availability_zone”的值为示例值。
- 正常响应样例
{ "instance": { "id": "dsfae23fsfdsae3435in01", "name": "trove-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "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": "postPaid" } }, "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": "cn-north-4", "availability_zone": "cn-north-4a", "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": "postPaid" }, "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": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a,cn-north-4b", "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": "postPaid" }, }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" }创建MySQL只读实例下发成功。
{ "instance":{ "id": "dsfae23fsfdsae3435in01", "name": "trove-instance-rep2", "flavor_ref": "rds.mysql.s1.large.rr", "volume": { "type": "CLOUDSSD", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "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" }创建MySQL Serverless型单机实例下发成功。
{ "instance": { "id": "4c57a8203dd348f3b789476165755b20in01", "name": "serverless_single1", "status": "BUILD", "datastore": { "type": "MySQL", "version": "5.7" }, "port": "3307", "volume": { "type": "CLOUDSSD", "size": 40 }, "region": "cn-north-4", "availability_zone": "cn-north-4a", "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "flavor_ref": "rds.mysql.serverless", "vpc_id": "bd3e4c67-74da-459d-820f-9fecd4ea9ca4", "subnet_id": "53cdf568-6f56-4944-a996-4afcaffe994e", "security_group_id": "89f258c5-4b81-4ef0-be30-34f2ee07dd1c", "charge_info": { "charge_mode": "postPaid" } }, "job_id": "3c1b8910-4191-4eed-9865-49bd82bac65b" }创建MySQL Serverless型主备实例下发成功。
{ "instance": { "id": "4c57a8203dd348f3b789476165755b20in01", "name": "serverless_ha1", "status": "BUILD", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "Ha", "replication_mode": "semisync" }, "port": "3307", "volume": { "type": "CLOUDSSD", "size": 40 }, "region": "cn-north-4", "availability_zone": "cn-north-4a,cn-north-4b", "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "flavor_ref": "rds.mysql.serverless.ha", "vpc_id": "bd3e4c67-74da-459d-820f-9fecd4ea9ca4", "subnet_id": "53cdf568-6f56-4944-a996-4afcaffe994e", "security_group_id": "89f258c5-4b81-4ef0-be30-34f2ee07dd1c", "charge_info": { "charge_mode": "postPaid" } }, "job_id": "3c1b8910-4191-4eed-9865-49bd82bac65b" } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
