该接口用于将RDS SQL Server备份数据恢复到新实例上。
接口说明
适用引擎
RDS SQL Server(2012 及以上版本的实例)
相关功能文档
注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:RecoveryDBInstance | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceClass | string | 否 | 新实例规格。详情请参见实例规格。 | mssql.x4.medium.s1 |
DBInstanceStorage | integer | 否 | 新实例存储容量。单位:GB。详情请参见实例规格。 说明
新实例的磁盘空间不能小于原实例的磁盘空间。
| 40 |
PayType | string | 否 | 新实例付费类型:
| Postpaid |
InstanceNetworkType | string | 否 | 新实例网络类型:
默认与原实例网络类型一致。 | VPC |
DBInstanceId | string | 否 | 原实例 ID。 说明
| rm-bp18**** |
TargetDBInstanceId | string | 否 | 目标实例 ID。 | rm-bp17**** |
DbNames | string | 是 | 数据库名称,恢复数据至新实例时格式为: 说明
如需恢复到已有实例,请参见 CopyDatabaseBetweenInstances 。
| test1,test2 |
BackupId | string | 否 | 备份集 ID,可通过查询备份列表接口 DescribeBackups 获取。 指定此参数时,DBInstanceId 参数为可选。 说明
BackupId 和 RestoreTime 两者至少传入一个。
| 29304**** |
RestoreTime | string | 否 | 备份保留周期内的任意时间点。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 指定此参数时,DBInstanceId 参数为必须。 说明
BackupId 和 RestoreTime 两者至少传入一个。
| 2011-06-11T16:00:00Z |
VPCId | string | 否 | 新实例专有网络 VPC ID。 | vpc-**** |
VSwitchId | string | 否 | 新实例虚拟交换机 ID,多个值用半角逗号(,)隔开。 | vsw-**** |
PrivateIpAddress | string | 否 | 设置新实例的内网 IP,需要在指定交换机的 IP 地址范围内。系统默认通过 VPCId 和 VSwitchId 自动分配。 | 172.XX.XX.69 |
UsedTime | string | 否 | 指定新实例购买时长,取值:
说明
若付费类型为 Prepaid 则该参数必须传入。
| 1 |
Period | string | 否 | 指定新的预付费实例为包年或者包月类型,取值:
说明
若参数 PayType=Prepaid,该参数必须传入。
| Month |
DBInstanceStorageType | string | 否 | 新实例存储类型,取值:
| cloud_essd |
返回参数
示例
正常返回示例
JSON
格式
{
"DBInstanceId": "rm-bp1v****",
"RequestId": "E4CDD460-2618-51FE-BD0B-A1****",
"OrderId": "2270972****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParameter | illegal parameter, param is empty. | 参数不正确。 |
400 | InvalidRecoveryDbInstance.StorageSize | The disk space of the new instance cannot be less than that of the current instance | 操作失败,新实例的磁盘空间不能小于当前实例的空间。 |
400 | DBCountLimitExceeded | Db count limit exceeded. | 超过了数据库计数限制。 |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
400 | Order.NoRealNameAuthentication | You 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. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0,请先充值后再尝试购买。 |
403 | Forbidden.SnapshotRecovery | Snapshot backup does not support partial restore | 操作失败,快照备份不支持部分还原。 |
403 | StorageLimitExceeded | Exceeding the allowed Storage of DB instance | 已超过磁盘空间限制,请清理磁盘空间。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-09-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
2023-06-09 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
|