云数据库 SQL Server 按照备份集回档数据库-回档相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（RestoreInstance）用于按照备份集回档数据库。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：RestoreInstance。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID，形如mssql-j8kv137v 示例值：mssql-njj2mtpl
BackupId	是	Integer	备份文件ID，该ID可以通过DescribeBackups接口返回数据中的Id字段获得示例值：32687264876
TargetInstanceId	否	String	备份恢复到的同一个APPID下的实例ID，不填则恢复到原实例ID 示例值：mssql-njj2mtpl
RenameRestore.N	否	Array of RenameRestoreDatabase	按照ReNameRestoreDatabase中的库进行恢复，并重命名，不填则按照默认方式命名恢复的库，且恢复所有的库。
Type	否	Integer	回档类型，0-覆盖方式；1-重命名方式，默认1 示例值：1
DBList.N	否	Array of String	需要覆盖回档的数据库，只有覆盖回档时必填示例值：["test_db"]
GroupId	否	String	备份任务组ID，在单库备份文件模式下示例值：2993992

3. 输出参数

参数名称	类型	描述
FlowId	Integer	异步流程任务ID，使用FlowId调用DescribeFlowStatus接口获取任务执行状态示例值：3546
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据备份集回档数据库

根据备份集回档数据库

输入示例

POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RestoreInstance
<公共请求参数>

{
    "InstanceId": "mssql-u81902ja",
    "BackupId": 0,
    "TargetInstanceId": "mssql-u8190212",
    "RenameRestore": [
        {
            "OldName": "test_db",
            "NewName": "new_db"
        }
    ],
    "GroupId": ""
}

输出示例

{
    "Response": {
        "FlowId": 0,
        "RequestId": "tqKar0yjquorXdNkDzkAZ8lh1_JTWJq3"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DBError	数据库错误。
FailedOperation.GcsError	操作失败或者网络超时。
InternalError.DBError	数据库错误。
InternalError.SystemError	系统错误。
InvalidParameter.InputIllegal	输入错误。
InvalidParameter.ParamsAssertFailed	参数断言转换错误。
InvalidParameterValue.DBExist	数据库已经存在。
LimitExceeded.TooManyDB	数据库超过限制。
ResourceNotFound.DBNotFound	数据库不存在。
ResourceNotFound.InstanceNotFound	实例不存在。
ResourceUnavailable.DBInvalidStatus	数据库状态无效。
ResourceUnavailable.InstanceStatusInvalid	实例状态无效。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

按照备份集回档数据库

本页目录：