# 恢复到新实例 - CreateRestoreInstance #### 功能介绍 从备份恢复到新实例。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=CreateRestoreInstance)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:create | write | - | - | - | - | #### 接口约束 - 源实例和目标实例的数据库类型必须一致，如都是MySQL。 - 原实例和目标实例的数据库版本约束如下： - RDS for MySQL和RDS for PostgreSQL的原实例和目标实例的数据库版本必须一致。 - RDS for SQL Server的原实例及目标实例的时区配置要完全一致，否则会有数据不一致风险。 - RDS for SQL Server的原实例和目标实例的数据库版本约束参见[表5]。 - RDS for MySQL和RDS for PostgreSQL数据库目标实例需大于或等于原实例的数据盘总大小。 #### URI - URI格式 POST /v3/{project_id}/instances - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 表2参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**： 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名，其中，SQL Server实例名唯一。 **约束限制**： 不涉及。 **取值范围：** - RDS for MySQL支持的字符长度是4\~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线、点或者下划线，不能包含其他的特殊字符。 - RDS for PostgreSQL和RDS for SQL Server支持的字符长度是4\~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线或者下划线，不能包含其他的特殊字符。 **默认取值**： 不涉及。 | | password | 否 | String | **参数解释**： 数据库密码。 **约束限制**： 不涉及。 **取值范围：** - 对于RDS for MySQL实例，密码长度为8\~32个字符，至少包含以下字符中的四种：大写字母、小写字母、数字和特殊字符 \~ ! @ # $ % \^ \* - _ = + ? , ( ) \& . \| - 对于RDS for PostgreSQL实例，密码长度为8\~32个字符，至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符 \~ ! @ # $ % \^ \* - _ = + ? , - 对于RDS for SQL Server实例，密码长度为8\~32个字符，至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符 \~ ! @ # $ % \^ \* - _ = + ? , . ( ) \& \| 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 **默认取值**： 不传该参数时，表示在实例创建完成后，通过重置密码的方式设置密码。 | | flavor_ref | 是 | String | **参数解释**： 规格码。 **约束限制**： 不涉及。 **取值范围**： 非空，详情请参考[查询数据库规格 - ListFlavors](https://support.huaweicloud.com/api-rds/rds_06_0002.html)的响应消息中的"spec_code"。 **默认取值**： 不涉及。 | | volume | 是 | Object | **参数解释**： volume信息。 详情请参见[表7]。 **约束限制**： 不涉及。 | | availability_zone | 是 | String | **参数解释**： 可用区ID。对于数据库实例类型不是单机的实例，需要分别为实例所有节点指定可用区，并用逗号隔开。详见示例。 调用[查询数据库规格 - ListFlavors](https://support.huaweicloud.com/api-rds/rds_06_0002.html)接口的返回信息中可以获取到可用区ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | restore_point | 是 | Object | **参数解释**： 恢复数据源对象。 详情请参见[表8]。 **约束限制**： 不涉及。 | | datastore | 否 | Object | **参数解释**： 数据库信息，仅适用于RDS for SQL Server数据库，跨版本恢复新实例时必传。 详情请参见[表4]。 恢复新实例的版本规则详见[表5]。 **约束限制**： 不涉及。 | | ha | 否 | Object | **参数解释**： HA配置参数，创建HA实例时使用。 详情请参见[表3]。 **约束限制**： 不涉及。 | | configuration_id | 否 | String | **参数解释**： 参数模板ID。 **约束限制**： 不涉及。 **取值范围**： 使用可参考[获取参数模板列表 - ListConfigurations](https://support.huaweicloud.com/api-rds/rds_09_0301.html)响应消息[表3](https://support.huaweicloud.com/api-rds/rds_09_0301.html#rds_09_0301__table1324110018258)中的"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。 | | backup_strategy | 否 | Object | **参数解释**： 高级备份策略。 详情请参见[表6]。 **约束限制**： 不涉及。 | | enterprise_project_id | 否 | String | **参数解释**： 企业项目ID。 **约束限制**： 不涉及。 **取值范围**： 使用请参考《企业管理 API参考》的"[查询企业项目列表](https://support.huaweicloud.com/api-em/zh-cn_topic_0121230880.html)"响应消息表"enterprise_project字段数据结构说明"的"id"。 **默认取值**： 不涉及。 | | disk_encryption_id | 否 | String | **参数解释**： 用于磁盘加密的密钥ID。 **约束限制**： 不涉及。 **取值范围**： 在[密钥管理](https://console.huaweicloud.com/dew/?#/dew/kms/keyList/customKey)界面获取密钥ID。 **默认取值**： 默认为空。 | | region | 否 | String | **参数解释**： 区域ID。 **约束限制**： SQL Server数据库和PostgreSQL数据库备份恢复到新实例时为必填项。 **取值范围**： 取值参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 **默认取值**： 不涉及。 | | vpc_id | 否 | String | **参数解释**： 虚拟私有云ID。 **约束限制**： SQL Server数据库和PostgreSQL数据库备份恢复到新实例时为必填项。 **取值范围**： 获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。 **默认取值**： 不涉及。 | | subnet_id | 否 | String | **参数解释**： 子网的网络ID信息。 **约束限制**： SQL Server数据库和PostgreSQL数据库备份恢复到新实例时为必填项。 **取值范围**： 获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。 **默认取值**： 不涉及。 | | data_vip | 否 | String | **参数解释**： 指定实例的内网IP，目前仅支持设置IPv4地址。 **约束限制**： 不涉及。 **取值范围**： 获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找子网的网段，选择未被占用的IP 。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询私有IP列表](https://support.huaweicloud.com/api-vpc/vpc_privateip_0003.html)，选择"device_owner"为空的私有IP。 **默认取值**： 默认为空。 | | security_group_id | 否 | String | **参数解释**： 安全组ID。 **约束限制**： 不涉及。 **取值范围**： 获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询安全组列表](https://support.huaweicloud.com/api-vpc/vpc_sg01_0003.html)。 最多支持添加10个安全组ID，安全组ID之间用英文逗号隔开。 **默认取值**： 不涉及。 | | charge_info | 否 | Object | **参数解释**： 计费类型信息，支持包周期和按需，默认为按需。 详情请参见[表9]。 **约束限制**： 目前，仅RDS for MySQL、RDS for SQL Server支持包周期模式下的恢复到新实例功能。 | | 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偏移量对照表](https://support.huaweicloud.com/api-rds/rds_01_0002.html#rds_01_0002__section1510432154710)的时区列。 **默认取值**： 不选择时，各个引擎时区如下： - MySQL默认为UTC时间。 - PostgreSQL默认为UTC时间。 - SQL Server默认为China Standard Time。 | | dsspool_id | 否 | String | **参数解释**： Dec用户专属存储ID。 **约束限制**： 每个az配置的专属存储不同，Dec用户创建实例时，对于数据库实例类型不是单机或只读的实例，需要分别为实例所有节点指定dsspoolId，并用逗号隔开。 **取值范围**： - 方法1：登录专属分布式存储服务DSS的控制台界面,查看专属存储列表，选择符合条件的az下的专属dss的ID。 - 方法2：通过专属分布式存储服务DSS的API接口查询,具体操作可参考[获取专属存储详情列表](https://support.huaweicloud.com/api-dss/dss_02_1002.html)。 **默认取值**： 不涉及。 | | collation | 否 | String | **参数解释**： SQL Server实例字符集。 **约束限制**： 仅限RDS for SQL Server实例创建使用。对于RDS for MySQL和RDS for PostgreSQL实例，该参数无意义。 **取值范围**： 根据[查询SQL Server可用字符集 - ListCollations](https://support.huaweicloud.com/api-rds/rds_05_0010.html)查询可设置的字符集。 **默认取值**： 不涉及。 | | tags | 否 | Array of objects | **参数解释**： 标签列表，根据标签键值对创建实例。 - {key}表示标签键，不可以为空或重复。 - {value}表示标签值，可以为空。 如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含20组。 详情请参见 [表10]。 **约束限制**： 不涉及。 | | dry_run | 否 | Boolean | **参数解释**： 是否只预检此次请求。 **约束限制**： 仅支持MySQL引擎。 **取值范围**： - true：发送参数检查请求，不会创建实例。 - 检查通过：返回202状态码。 - 检查不通过：返回对应错误码，详情请参考[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。 - false：发送正常请求，通过检查后，并且执行创建实例的请求。 **默认取值**： 不涉及。 | | is_auto_upgrade | 否 | Boolean | **参数解释**： 是否开启自动小版本升级。 **约束限制**： 仅支持RDS for PostgreSQL实例。 **取值范围**： - true：开启自动小版本升级。 - false：不开启自动小版本升级。 **默认取值**： false | 表3ha字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | mode | 是 | String | **参数解释**： 实例主备模式。 **约束限制**： 不涉及。 **取值范围**： HA，不区分大小写。 **默认取值**： 不涉及。 | | replication_mode | 是 | String | **参数解释**： 备机同步参数。 **约束限制**： 不涉及。 **取值范围**： - RDS for MySQL为"async"或"semisync"。 - RDS for PostgreSQL为"async"或"sync"。 - RDS for SQL Server为"sync"。 说明： - "async"为异步模式。 - "semisync"为半同步模式。 - "sync"为同步模式。 **默认取值**： 不涉及。 | 表4datastore字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | type | 是 | String | **参数解释**： 数据库引擎。 **约束限制**： 不涉及。 **取值范围**： SQLServer **默认取值**： 不涉及。 | | version | 是 | String | **参数解释**： 数据库版本。 **约束限制**： 不涉及。 **取值范围**： - Microsoft SQL Server：仅支持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版不支持购买，仅存量经营。 数据库支持的详细版本信息，可调用[查询数据库引擎的版本 - ListDatastores](https://support.huaweicloud.com/api-rds/rds_06_0001.html)接口获取。 **默认取值**： 不涉及。 | 表5RDS for SQL Server恢复支持的版本规则 | 原数据库版本 | 可恢复到的版本 | |:---|:---| | 2008 R2 web版 | 2012 web版 2012 标准版 2012 企业版 2014 web版 2014 标准版 2014 企业版 2016 web版 2016 标准版 2016 企业版 2017 web版 2017 标准版 2017 企业版 | | 2008 R2 企业版 | 2012 企业版 2014 企业版 2016 企业版 2017 企业版 | | 2008 R2 标准版 | 2012 标准版 2012 企业版 2014 标准版 2014 企业版 2016 标准版 2016 企业版 2017 标准版 2017 企业版 | | 2012 web版 | 2012 web版 2012 标准版 2012 企业版 2014 web版 2014 标准版 2014 企业版 2016 web版 2016 标准版 2016 企业版 2017 web版 2017 标准版 2017 企业版 | | 2012 标准版 | 2012 标准版 2012 企业版 2014 标准版 2014 企业版 2016 标准版 2016 企业版 2017 标准版 2017 企业版 | | 2012 企业版 | 2012 企业版 2014 企业版 2016 企业版 2017 企业版 | | 2014 web版 | 2014 web版 2014 标准版 2014 企业版 2016 web版 2016 标准版 2016 企业版 2017 web版 2017 标准版 2017 企业版 | | 2014 标准版 | 2014 标准版 2014 企业版 2016 标准版 2016 企业版 2017 标准版 2017 企业版 | | 2014 企业版 | 2014 企业版 2016 企业版 2017 企业版 | | 2016 web版 | 2016 web版 2016 标准版 2016 企业版 2017 web版 2017 标准版 2017 企业版 | | 2016 标准版 | 2016 标准版 2016 企业版 2017 标准版 2017 企业版 | | 2016 企业版 | 2016 企业版 2017 企业版 | | 2017 web版 | 2017 web版 2017 标准版 2017 企业版 | | 2017 标准版 | 2017 标准版 2017 企业版 | | 2017 企业版 | 2017 企业版 | 表6backup_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 SQL Server实例不支持关闭自动备份策略。 **取值范围**： - 对于RDS for MySQL实例，支持0～732天。取值为0，表示关闭自动备份策略，且关闭后无法再次开启自动备份策略。如果需要延长保留时间请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请，自动备份最长可以保留10年。 - 对于RDS for PostgreSQL实例，支持0\~3660天。取值为0，表示关闭自动备份策略，且关闭后无法再次开启自动备份策略。 - 对于RDS for SQL Server实例，支持1～732天。如果需要延长保留时间请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请，自动备份最长可以保留10年。 **默认取值**： - 对于RDS for MySQL实例，该参数缺省时默认为0。 - 对于RDS for PostgreSQL实例，该参数缺省时默认为0。 - 对于RDS for SQL Server实例，该参数缺省时默认保留7天。 | 表7volume字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | type | 是 | String | **参数解释**： 磁盘类型。 **约束限制**： 不涉及。 **取值范围**： 取值如下，区分大小写： - ULTRAHIGH，表示超高IO型磁盘。 - LOCALSSD，表示本地SSD盘。 - CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。 - ESSD，表示极速型SSD。 - ESSD2，表示极速型SSD V2。 **默认取值**： 不涉及。 | | size | 是 | Integer | **参数解释**： 磁盘大小。 **约束限制**： RDS for MySQL新实例磁盘大小必须大于或等于原实例的磁盘大小。 RDS for PostgreSQL： - 按全量备份文件恢复：新实例磁盘大小必须大于或等于[获取备份列表](https://support.huaweicloud.com/api-rds/rds_09_0005.html)接口返回字段"min_data_volume_capacity_for_restore" 的值。 - 按时间点恢复：新实例磁盘大小必须大于或等于原实例的磁盘大小。 **取值范围：** - 对于MySQL引擎：单机和主备实例是20GB\~10000GB，集群版实例是20GB\~4000GB，必须为10的整数倍。 - 对于PostgreSQL引擎：40GB\~4000GB，必须为10的整数倍。 - 对于SQL Server引擎：40GB\~10000GB，必须为10的整数倍。 **默认取值**： 不涉及。 | 表8restore_point字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | instance_id | 是 | String | **参数解释**： 实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | type | 是 | String | **参数解释**： 表示恢复方式。 **约束限制**： 不涉及。 **取值范围**： - "backup"，表示使用备份文件恢复，按照此方式恢复时，当"type"字段为非必选时，"backup_id"必选。 - "timestamp"，表示按时间点恢复，按照此方式恢复时，当"type"字段必选时，"restore_time"必选。 **默认取值**： 不涉及。 | | backup_id | 否 | String | **参数解释**： 用于恢复的备份ID。 **约束限制**： - 当使用备份文件恢复时需要指定该参数。 - 不支持恢复增量备份的数据。 - 当"type"字段为非必选时，"backup_id"必选。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | restore_time | 否 | Integer | **参数解释**： 恢复数据的时间点，格式为UNIX时间戳，单位是毫秒，时区为UTC。 **约束限制**： 当"type"字段必选时，"restore_time"必选。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | database_name | 否 | Map\ | **参数解释**： 数据库名称。 **约束限制**： 仅适用于SQL Server引擎，当有此参数时表示支持局部恢复和重命名恢复，恢复数据以局部恢复为主。 **取值范围**： - 新数据库名可填写多个，用英文逗号分隔，新数据库名称中可包含原库名。 - 新数据库名称填写限制如下： - 新库名不可以与原库名相同，为空时，默认恢复与原库名相同。 - 根据创建实例时所选择的字符集判断数据库名称是否大小写敏感，保证新数据库名称之间不可以重复。 - 新数据库名称与原实例数据库名称不可以冲突。 - 所有新数据库名称数量不可以超出数据库数量配额，数据库数量配额参数名：rds_databases_quota。 - 新数据库名不能包含rdsadmin、master、msdb、tempdb、model或resource字段（不区分大小写）。 - 新数据库名称长度在1\~64个字符之间，包含字母、数字、下划线或中划线，不能包含其他特殊字符，如恢复到多个新数据库，可通过英文逗号分隔。 **示例：** ``` "database_name":{"原数据库名称":"新数据库名称"} ``` 正确示例："database_name":{"A":"A,A1,A2","B":"B1,B2","C":""} 错误示例："database_name":{"A":"A","B":"B1,B2","C":"B1,C1","D":"D1,d1"}, 错误原因如下： 1. 原数据库名称不可以等于新数据库名称； 2. 新数据库名称相互之间冲突重复，新库名的集合中B1重复； 3. 实例数据库名大小写不敏感情况下，D1与d1数据库名称冲突。 注意： 恢复前请评估恢复后的数据大小是否超出当前购买的磁盘大小，避免恢复过程中由于磁盘容量限制导致恢复失败。 **默认取值**： 不填写该字段时，默认恢复全部数据库。 | 表9charge_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。 **默认取值**： 不涉及。 | | is_auto_renew | 否 | boolean | **参数解释**： 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 **约束限制**： 不涉及。 **取值范围**： - true，为自动续订。 - false，为不自动续订，默认该方式。 **默认取值**： false | | is_auto_pay | 否 | boolean | **参数解释**： 创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 **约束限制**： 不涉及。 **取值范围**： - true，为自动支付。 - false，为手动支付，默认该方式。 **默认取值**： false | 表10tags字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | key | 是 | String | **参数解释**： 标签键。 **约束限制**： 不涉及。 **取值范围**： 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@()，但首尾不能含有空格，不能以_sys_开头。 **默认取值**： 不涉及。 | | value | 是 | String | **参数解释**： 标签值。 **约束限制**： 不涉及。 **取值范围**： 最大长度255个unicode字符，可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@()。 **默认取值**： 不涉及。 | #### 请求示例 - 将MySQL备份文件恢复到新实例。 ``` POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances { "name": "targetInst", "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "async" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "CLOUDSSD", "size": 40 }, "region": "aaa", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "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", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "password": "Demo@12345678", "configuration_id": "52e86e87445847a79bf807ceda213165pr01", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "time_zone": "UTC+04:00", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" } } ``` - 将SQL Server备份文件中的部分数据库恢复到新实例。 ``` { "name": "targetInst", "datastore": { "type": "SQLServer", "version": "2014_SE" }, "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "sync" }, "flavor_ref": "rds.mssql.2014.se.s3.xlarge.2.ha", "volume": { "type": "ULTRAHIGH", "size": 40 }, "region": "aaa", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "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", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "charge_info": { "charge_mode": "prePaid", "period_type": "month", "period_num": 1, "is_auto_renew": false, "is_auto_pay": true }, "password": "Demo@12345678", "configuration_id": "52e86e87445847a79bf807ceda213165pr04", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "time_zone": "China Standard Time", "collation": "Cyrillic_General_CI_AS", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe", "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db002", "db3": "" } } } ``` - 将MySQL实例的数据恢复到指定时间点。 ``` { "name": "targetInst", "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "async" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "CLOUDSSD", "size": 40 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "data_vip": "192.168.0.147", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "password": "Demo@12345678", "configuration_id": "52e86e87445847a79bf807ceda213165pr01", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "time_zone": "UTC+04:00", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 } } ``` - 将SQL Server实例的部分数据库恢复到指定时间点。 ``` { "name": "targetInst", "datastore": { "type": "SQLServer", "version": "2014_SE" }, "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "sync" }, "flavor_ref": "rds.mssql.2014.se.s3.xlarge.2.ha", "volume": { "type": "ULTRAHIGH", "size": 40 }, "region": "aaa", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "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", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "charge_info": { "charge_mode": "prePaid", "period_type": "month", "period_num": 1, "is_auto_renew": false, "is_auto_pay": true }, "password": "Demo@12345678", "configuration_id": "52e86e87445847a79bf807ceda213165pr04", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "time_zone": "China Standard Time", "collation": "Cyrillic_General_CI_AS", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04", "type": "timestamp", "restore_time": 1532001446987, "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db02", "db3": "" } } } ``` #### 响应消息 - 正常响应要素说明 表11要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | instance | Object | **参数解释**： 实例信息。 详情请参见[表12]。 | | job_id | String | **参数解释**： 实例创建的任务id。仅按需实例时返回该参数。 **取值范围**： 不涉及。 | | order_id | String | **参数解释**： 订单号，仅RDS for SQL Server创建包周期实例时返回该参数。 **取值范围**： 不涉及。 | 表12instance说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名，其中，RDS for SQL Server实例名唯一。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 实例状态。 **取值范围**： 如BUILD，表示创建中。 | | datastore | Object | **参数解释**： 数据库信息。 详情请参见[表13]。 | | ha | Object | **参数解释**： HA配置参数，仅当您选择创建HA实例时该参数才可见。 详情请参见[表14]。 | | configuration_id | String | **参数解释**： 参数模板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。 | | backup_strategy | Object | **参数解释**： 自动备份策略。 详情请参见[表15]。 | | enterprise_project_tag | String | **参数解释**： 项目标签。 **取值范围**： 不涉及。 | | flavor_ref | String | **参数解释**： 规格ID。 **取值范围**： 使用可参考[查询数据库规格 - ListFlavors](https://support.huaweicloud.com/api-rds/rds_06_0002.html)响应消息[表3](https://support.huaweicloud.com/api-rds/rds_06_0002.html#rds_06_0002__table66531170)中的"spec_code"。 | | volume | Object | **参数解释**： volume信息。 详情请参见[表16]。 | | region | String | **参数解释**： 区域ID。 **取值范围**： 不涉及。 | | availability_zone | String | **参数解释**： 可用区ID。 **取值范围**： 不涉及。 | | vpc_id | String | **参数解释**： 虚拟私有云ID。 **取值范围**： 获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。 | | subnet_id | String | **参数解释**： 子网的网络ID信息。 **取值范围**： 获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。 | | security_group_id | String | **参数解释**： 指定实例所属的安全组。 **取值范围**： 获取方法如下： - 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询安全组列表](https://support.huaweicloud.com/api-vpc/vpc_sg01_0003.html)。 | | collation | String | **参数解释**： RDS for SQL Server设定的字符集信息。 **取值范围**： 不涉及。 | | charge_info | Object | **参数解释**： 计费方式信息，支持包年/包月和按需。 详情请参见[表9]。 | 表13datastore字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | type | 是 | String | **参数解释**： 数据库引擎。 **取值范围**： 支持的引擎如下，不区分大小写： - MySQL - PostgreSQL - SQLServer | | version | 是 | String | **参数解释**： 数据库版本。 **取值范围**： 数据库支持的详细版本信息，可调用[查询数据库引擎的版本 - ListDatastores](https://support.huaweicloud.com/api-rds/rds_06_0001.html)接口获取。 | | complete_version | 否 | String | **参数解释**： 数据库完整版本号。仅在数据库引擎是"PostgreSQL"时返回。 **取值范围**： 不涉及。 | 表14ha字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | mode | 是 | String | **参数解释**： 实例主备模式。 **取值范围**： Ha | | replication_mode | 是 | String | **参数解释**： 备机同步参数。 **取值范围**： 非空。 - MySQL为"async"或"semisync"。 - PostgreSQL为"async"或"sync"。 - Microsoft SQL Server为"sync"。 说明： - "async"为异步模式。 - "semisync"为半同步模式。 - "sync"为同步模式。 | 表15backupStrategy字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | 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实例，支持0～732天。取值为0，表示关闭自动备份策略，且关闭后无法再次开启自动备份策略。如果需要延长保留时间请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请，自动备份最长可以保留10年。 - 对于RDS for PostgreSQL实例，支持0\~3660天。取值为0，表示关闭自动备份策略，且关闭后无法再次开启自动备份策略。 - 对于RDS for SQL Server实例，支持1～732天。如果需要延长保留时间请[提交工单](https://console.huaweicloud.com/ticket/?locale=zh-cn#/ticketindex/createIndex)申请，自动备份最长可以保留10年。 | 表16volume字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | type | 是 | String | **参数解释**： 磁盘类型。 **取值范围**： 区分大小写： - ULTRAHIGH，表示超高IO型磁盘。 - LOCALSSD，表示本地SSD盘。 - CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。 - ESSD，表示极速型SSD。 | | size | 是 | Integer | **参数解释**： 磁盘大小。 **取值范围：** - 对于MySQL引擎：单机和主备实例是20GB\~10000GB，集群版实例是20GB\~4000GB，必须为10的整数倍。 - 对于PostgreSQL引擎：40GB\~4000GB，必须为10的整数倍。 - 对于SQL Server引擎：40GB\~10000GB，必须为10的整数倍。 | - 正常响应样例 **MySQL** ``` { "instance": { "id": "f5ffdd8b1c98434385eb001904209eacin01", "name": "demoname", "status": "BUILD", "datastore": { "type": "MySQL", "version": "5.7.31" }, "port": "3306", "volume": { "type": "CLOUDSSD", "size": "40" }, "region": "aaa", "backup_strategy": { "start_time": "02:00-03:00", "keep_days": "7" }, "flavor_ref": "rds.mysql.s1.large", "availability_zone": "bbb", "vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f", "subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7", "security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0" }, "job_id": "bf003379-afea-4aa5-aa83-4543542070bc" } ``` **PostgreSQL** ``` { "instance": { "id": "f5ffdd8b1c98434385eb001904209eacin01", "name": "demoname", "status": "BUILD", "datastore": { "type": "PostgreSQL", "version": "9.6.13" }, "port": "5432", "volume": { "type": "CLOUDSSD", "size": "40" }, "region": "aaa", "backup_strategy": { "start_time": "02:00-03:00", "keep_days": "7" }, "flavor_ref": "rds.pg.s1.large", "availability_zone": "bbb", "vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f", "subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7", "security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0" }, "job_id": "bf003379-afea-4aa5-aa83-4543542070bc" } ``` **SQL Server** ``` { "instance": { "id": "f5ffdd8b1c98434385eb001904209eacin01", "name": "demoname", "status": "BUILD", "datastore": { "type": "sqlserver", "version": "2014_SE" }, "port": "2100", "volume": { "type": "ULTRAHIGH", "size": "40" }, "region": "aaa", "backup_strategy": { "start_time": "02:00-03:00", "keep_days": "7" }, "flavor_ref": "rds.mssql.2014.se.s3.large.2", "availability_zone": "bbb", "vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f", "subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7", "security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0", "charge_info": { "charge_mode": "prePaid", "period_num": 1 }, "collation": "Cyrillic_General_CI_AS" }, "order_id": "CS20122919584LQ7K" } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 202 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。