API 文档

根据备份文件恢复实例

最近更新时间:2020-11-30 08:29:11

我的收藏

1. 接口描述

接口请求域名: sqlserver.tencentcloudapi.com 。

本接口(RestoreInstance)用于根据备份文件恢复实例。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:sqlserver.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RestoreInstance。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID,形如mssql-j8kv137v
BackupId Integer 备份文件ID,该ID可以通过DescribeBackups接口返回数据中的Id字段获得
TargetInstanceId String 备份恢复到的同一个APPID下的实例ID,不填则恢复到原实例ID
RenameRestore.N Array of RenameRestoreDatabase 按照ReNameRestoreDatabase中的库进行恢复,并重命名,不填则按照默认方式命名恢复的库,且恢复所有的库。

3. 输出参数

参数名称 类型 描述
FlowId Integer 异步流程任务ID,使用FlowId调用DescribeFlowStatus接口获取任务执行状态
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 恢复实例

输入示例

https://sqlserver.tencentcloudapi.com/?Action=RestoreInstance
&InstanceId=mssql-njj2mtpl
&BackupId=32687264876
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
    "FlowId": 3546
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.DBError 数据库错误。
InternalError.SystemError 系统错误。
InvalidParameter.InputIllegal 输入错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
ResourceNotFound.InstanceNotFound 实例不存在。
ResourceUnavailable.InstanceStatusInvalid 实例状态无效。
UnauthorizedOperation.PermissionDenied cam鉴权错误。
目录