创建数据库实例
功能介绍
创建RDS实例,可分为单机实例、主备实例和只读实例。
- 调用接口前,您需要了解API认证鉴权。
- 调用接口前,您需要了解请求Header参数说明。
本接口支持创建RDS for MySQL实例时,在HTTP请求消息头中设置X-Client-Token请求头,保证请求幂等性。详细信息请参考请求幂等性说明。
URI
- URI格式
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释:
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
请求消息
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
name |
是 |
String |
参数解释: 实例名称。同一租户下,同类型的实例名可重名。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
datastore |
是 |
Object |
参数解释: 数据库信息。 详情请参见表4。 约束限制: 不涉及。 |
flavor_ref |
是 |
String |
参数解释: 规格码。 约束限制: 不涉及。 取值范围: 非空,使用可参考查询数据库规格响应消息表3中的“spec_code”。 默认取值: 不涉及。 |
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。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 默认为空。 |
data_vip |
否 |
String |
参数解释: 指定实例的内网IP,目前仅支持设置IPv4地址。 约束限制: 不涉及。 取值范围:
默认取值: 默认为空。 |
charge_info |
否 |
Object |
参数解释: 计费类型信息,支持包年包月和按需,默认为按需。 详情请参见表8。 约束限制: 不涉及。 |
time_zone |
否 |
String |
参数解释: UTC时区。 约束限制: 不涉及。 取值范围: MySQL和PostgreSQL引擎选择填写时,取值范围为UTC-12:00~UTC+12:00,且只支持整段时间,如UTC+08:00,不支持UTC+08:30。 默认取值:
不选择时,各个引擎时区如下:
|
restore_point |
否 |
Object |
参数解释: 恢复数据源对象。恢复到新实例时必选。 详情请参见表10。 约束限制: 不涉及。 |
tags |
否 |
Array of objects |
参数解释: 标签列表,根据标签键值对创建实例。
如果创建实例时同时使用多个标签键值对,中间使用逗号分隔开,最多包含20组。 详情请参见 表9。 约束限制: 不涉及。 |
unchangeable_param |
否 |
Object |
参数解释: 不可变更参数列表。该对象中的参数,在数据库初始化之前指定,指定后不支持修改。 详情参见表11。 约束限制: 不涉及。 |
collation |
否 |
String |
参数解释: SQL Server实例字符集。 约束限制: 仅限RDS for SQL Server实例创建使用。对于RDS for MySQL和RDS for PostgreSQL实例,该参数无意义。 取值范围: 根据查询SQL Server可用字符集查询可设置的字符集。 默认取值: 不涉及。 |
dry_run |
否 |
Boolean |
参数解释: 是否只预检此次请求。 约束限制: 仅支持MySQL引擎。 取值范围:
默认取值: 不涉及。 |
count |
否 |
Integer |
参数解释: 批量创建实例的数量。 约束限制: 创建只读实例时,不支持设置该参数。 取值范围: 1~50。 默认取值: 不涉及。 |
is_auto_upgrade |
否 |
Boolean |
参数解释: 是否开启自动小版本升级。 约束限制: 仅支持RDS for PostgreSQL实例。 取值范围:
默认取值: false |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
name |
是 |
String |
参数解释: 实例名称。 用于表示实例的名称,同一租户下,同类型的实例名可重名。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
replica_of_id |
是 |
String |
参数解释: 只读实例的主实例ID。 约束限制: 创建只读实例时必选,其它场景不可选。 取值范围: 不涉及。 默认取值: 不涉及。 |
flavor_ref |
是 |
String |
参数解释: 规格码。 约束限制: 不涉及。 取值范围: 非空,使用可参考查询数据库规格响应消息表3中的“spec_code”。 默认取值: 不涉及。 |
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暂时不支持包周期只读实例。 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
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 |
参数解释: 指定备份文件的可保存天数。 约束限制: RDS for SQL Server的HA实例不支持关闭自动备份策略。 取值范围: 0~732。该参数缺省,或取值为0,表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请,自动备份最长可以保留2562天。 默认取值: 不涉及。 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
type |
是 |
String |
参数解释: 磁盘类型。 约束限制: 不涉及。 取值范围: 取值如下,区分大小写:
默认取值: 不涉及。 |
size |
是 |
Integer |
参数解释: 磁盘大小。 约束限制: 对于只读实例,该参数无效,磁盘大小,默认和主实例相同。 取值范围: 40GB~4000GB,必须为10的整数倍。 默认取值: 不涉及。 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
charge_mode |
是 |
String |
参数解释: 计费模式。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
period_type |
否 |
String |
参数解释: 订购周期类型。 约束限制: “charge_mode”为“prePaid”时生效,且为必选值。 取值范围:
默认取值: 不涉及。 |
period_num |
否 |
Integer |
参数解释: 订购时长。 约束限制: “charge_mode”为“prePaid”时生效,且为必选值,指定订购的时间。 取值范围:
默认取值: 不涉及。 |
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
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": "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.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": "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": "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": "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.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": "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.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" } ], }
- 创建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": "ap-southeast-1", "availability_zone": "ap-southeast-1a,ap-southeast", "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 }
- 创建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": "ap-southeast-1", "availability_zone": "ap-southeast-1a", "enterprise_project_id": "fdsa-3rds", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }
响应消息
- 正常响应要素说明
表12 要素说明 名称
参数类型
说明
instance
Object
参数解释:
实例信息。
详情请参见表13。
job_id
String
参数解释:
实例创建的任务id。
查询详细任务信息请参见获取指定ID的任务信息。
仅创建按需实例时会返回该参数。
取值范围:
不涉及。
order_id
String
参数解释:
订单号,创建包年包月时返回该参数。
取值范围:
不涉及。
表13 instance说明 名称
参数类型
说明
id
String
参数解释:
实例ID,批量创建实例时,MySQL返回字段为多个实例ID以英文逗号(,)隔开,其他引擎该字段为空。
取值范围:
不涉及。
name
String
参数解释:
实例名称。用于表示实例的名称,同一租户下,同类型的实例名称可相同。
取值范围:
不涉及。
status
String
参数解释:
实例状态。
取值范围:
如BUILD,表示创建中。
仅创建按需实例时会返回该参数。
datastore
Object
参数解释:
数据库信息。
详情请参见表14。
ha
Object
参数解释:
HA配置参数,仅当您选择创建HA实例时该参数才可见。
详情请参见表15。
configuration_id
String
参数解释:
参数模板ID,仅当您创建实例指定用户自定义参数组时,该参数才可见。
取值范围:
不涉及。
port
String
参数解释:
数据库端口信息。
取值范围:
与请求参数相同。
backup_strategy
Object
参数解释:
自动备份策略。
详情请参见表16。
enterprise_project_id
String
参数解释:
项目标签。
取值范围:
不涉及。
disk_encryption_id
String
参数解释:
用于磁盘加密的密钥ID。
取值范围:
仅当您创建实例选择该参数时才可见,默认为空。
flavor_ref
String
参数解释:
规格码。
取值范围:
volume
Object
参数解释:
volume信息。
详情请参见表17。
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
参数解释:
计费方式信息,支持包年/包月和按需。
详情请参见表18。
collation
String
参数解释:
RDS for SQL Server设定的字符集信息。
取值范围:
不涉及。
restore_point
Object
参数解释:
恢复数据源对象。恢复到新实例时必选。
详情请参见表19。
表14 datastore字段数据结构说明 名称
参数类型
说明
type
String
参数解释:
数据库引擎。
取值范围:
- MySQL
- PostgreSQL
- SQLServer
version
String
参数解释:
数据库版本。
取值范围:
数据库支持的详细版本信息,可调用查询数据库引擎的版本接口获取。
表15 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”为同步模式。
表16 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”。
表17 volume字段数据结构说明 名称
参数类型
说明
type
String
参数解释:
磁盘类型。
取值范围:
区分大小写。
- ULTRAHIGH,表示超高IO型磁盘。
- CLOUDSSD,表示SSD云盘,仅支持通用型和独享型规格实例。
- ESSD,表示极速型SSD。
size
Integer
参数解释:
磁盘大小。
取值范围:
40GB~4000GB。必须为10的整数倍。
表18 chargeInfo字段数据结构说明 名称
参数类型
说明
charge_mode
String
参数解释:
创建类型,支持包年/包月和按需。
取值范围:
不涉及。
period_num
Integer
参数解释:
订购周期长度,按月计算。
“charge_mode”为“prePaid”,即包年/包月时该字段生效。
取值范围:
不涉及。
表19 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”的值为示例值。
- 正常响应样例
{ "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": "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": "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": "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": "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": "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": "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": "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", "configuration_id": "452408-44c5-94be-305145fg" }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" }
- 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。