首页 云数据库 RDS 开发参考 API参考 API目录 恢复 RecoveryDBInstance - 恢复数据库

RecoveryDBInstance - 恢复数据库

更新时间: 2023-09-26 14:52:24

该接口用于恢复RDS SQL Server数据库。

接口说明

适用引擎

RDS SQL Server（2012及以上版本的实例）

相关功能文档

注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
恢复SQL Server数据

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:RecoveryDBInstanceWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
无

请求参数

名称类型必填描述示例值
DBInstanceClassstring否

新实例规格。详情请参见实例规格。

mssql.x4.medium.s1
DBInstanceStorageinteger否

新实例存储容量。单位：GB。详情请参见实例规格。

说明 新实例的磁盘空间不能小于原实例的磁盘空间。
40
PayTypestring否

新实例付费类型：

  • Postpaid：后付费（按量付费）
  • Prepaid：预付费（包年包月）
Postpaid
InstanceNetworkTypestring否

新实例网络类型：

  • Classic：经典网络
  • VPC：专有网络

默认与原实例网络类型一致。

VPC
DBInstanceIdstring否

原实例ID。

说明
  • 按备份集恢复（即指定BackupId参数）时，本参数不是必须项。
  • 按时间点恢复（即指定RestoreTime参数）时，本参数为必须项。
    •
    		rm-bp18****
    TargetDBInstanceIdstring否

    目标实例ID。

    		rm-bp17****
    DbNamesstring是

    数据库名称。

    • 若恢复数据至新实例，按如下格式：原库名1,新库名2。
    • 若恢复数据至已有实例，按如下格式：{"原库名1":"新库名1","原库名2":"新库名2"}。
    		恢复实例至新实例：test1,test2；恢复实例至已有实例：{"test1":"newtest1","test2":"newtest2"}
    BackupIdstring否

    备份集ID，可通过查询备份列表接口DescribeBackups获取。

    指定此参数时，DBInstanceId参数为可选。

    说明 BackupId和RestoreTime两者至少传入一个。
    		29304****
    RestoreTimestring否

    备份保留周期内的任意时间点。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    指定此参数时，DBInstanceId参数为必须。

    说明 BackupId和RestoreTime两者至少传入一个。
    		2011-06-11T16:00:00Z
    VPCIdstring否

    新实例专有网络VPC ID。

    		vpc-****
    VSwitchIdstring否

    新实例虚拟交换机ID，多个值用半角逗号（,）隔开。

    		vsw-****
    PrivateIpAddressstring否

    设置新实例的内网IP，需要在指定交换机的IP地址范围内。系统默认通过VPCId和VSwitchId自动分配。

    		172.XX.XX.69
    UsedTimestring否

    指定新实例购买时长，取值：

    • 当参数Period为Year时，UsedTime取值为1~3。
    • 当参数Period为Month时，UsedTime取值为1~9。
    说明 若付费类型为Prepaid则该参数必须传入。
    		1
    Periodstring否

    指定新的预付费实例为包年或者包月类型，取值：

    • Year：包年
    • Month：包月
    说明 若参数PayType=Prepaid，该参数必须传入。
    		Month
    DBInstanceStorageTypestring否

    新实例存储类型，取值：

    • local_ssd/ephemeral_ssd：本地SSD盘
    • cloud_ssd：SSD云盘
    • cloud_essd：ESSD云盘
    		cloud_essd

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    DBInstanceIdstring

    实例ID。

    		rm-bp1v****
    RequestIdstring

    请求ID。

    		E4CDD460-2618-51FE-BD0B-A1****
    OrderIdstring

    订单ID。

    		2270972****

    示例

    正常返回示例

    JSON格式

    {
  "DBInstanceId": "rm-bp1v****",
  "RequestId": "E4CDD460-2618-51FE-BD0B-A1****",
  "OrderId": "2270972****"
}

    错误码

    HTTP status code错误码错误信息描述
    400IllegalParameterillegal parameter, param is empty.参数不正确。
    400InvalidRecoveryDbInstance.StorageSizeThe disk space of the new instance cannot be less than that of the current instance操作失败，新实例的磁盘空间不能小于当前实例的空间。
    400DBCountLimitExceededDb count limit exceeded.超过了数据库计数限制。
    403Forbidden.SnapshotRecoverySnapshot backup does not support partial restore操作失败，快照备份不支持部分还原。
    403StorageLimitExceededExceeding the allowed Storage of DB instance已超过磁盘空间限制，请清理磁盘空间。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-09-08OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 403 变更
      删除错误码：400
    2023-06-09OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码：400
      删除错误码：403
    阿里云首页 云数据库 RDS 相关技术圈