调用 RestoreToExistedInstance 接口，以数据库为单位，将数据恢复到已有实例。

注意事项

根据实例兼容版本的不同，在数据恢复时存在以下限制：

当原实例为 Web 版实例即 DBEngineVersion 取值为 SQLServer_2019_Web 时，支持将实例还原至企业版、标准版或 Web 版实例即 DBEngineVersion 取值为 SQLServer_2019_Std、SQLServer_2019_Ent 或 SQLServer_2019_Web。

当原实例为标准版实例即 DBEngineVersion 取值为 SQLServer_2019_Std 时，支持将实例还原至企业版、标准版实例即 DBEngineVersion 取值为 SQLServer_2019_Std 或 SQLServer_2019_Ent。

当原实例为企业版实例即 DBEngineVersion 取值为 SQLServer_2019_Ent 时，支持将实例还原至企业版实例即 DBEngineVersion 取值为 SQLServer_2019_Ent。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：RestoreToExistedInstance

要执行的操作，取值：RestoreToExistedInstance。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

SourceDBInstanceId string 必选示例值：mssql-bbe31c86****

源实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

TargetDBInstanceId string 必选示例值：mssql-bbe31c86****

目标实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

若与源实例 ID 相同则为恢复到源实例。

Databases object[] 必选示例值：无

待恢复的数据库信息。

说明

最多可传入 100 个数据库信息。

DBName string 必选示例值：test

原数据库名称。

NewDBName string 可选示例值：test_bak

新数据库新名称。命名规则如下：

以字母开头，字母或数字结尾。

长度需要在 2~60 个字符内。

由字母、数字、下划线（_）组成，且字母的大小写不敏感。

不能使用 master、msdb、model、tempdb、resource、rdsadmin、distribution 等预留字。

说明

当调用 CreateTosRestore 接口创建 TOS 备份恢复任务时，需关注以下信息：

当不配置该参数时，默认原数据库名称保持一致。

当设置该参数时，同时 BackupType 选择 Full，那么新库名不可以和已有库名重复，如果 BackupType 选择 Diff 或 LOG，那么新库名必须已存在。

BackupId string 可选示例值：f569f53bf60a48d5b****

源实例备份集 ID。

说明

按备份集恢复数据库时，您可以通过调用 DescribeBackups 查询BackupId。

BackupId 和 RestoreTime 传入一个即可。

RestoreTime string 可选示例值：2023-08-23T08:04:59Z

按时间点恢复数据库，可以选择备份保留周期内的任意时间点。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

说明

BackupId 和 RestoreTime 传入一个即可。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：mssql-1be522b5****

源实例 ID。

请求示例 1

返回示例 1

请求示例 2

返回示例 2

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	OperationDenied_ImportJobExists	The operation is not permitted due to exist running import job.	当前实例正在执行数据导入任务，无法执行该操作。
400	UserBackupAmountOverTheLimit	The operation is not permitted due to the user backup amount over the limit.	手动备份的数量超过上限。
400	OperationDenied_BackupJobExists	The operation is not permitted due to exist running backup job.	当前实例正在执行备份任务，无法执行该操作。
400	OperationUnsupported	The operation is unsupported for the specified instance.	操作不支持。
400	InstanceIsNotRunning	The specified instance is not running.	当前实例状态不在运行中。
400	OperationDenied_IncrBackupUnsupportRecovery	The operation is not permitted due to incr backup unsupport recovery.	增量备份无法执行该操作。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	缺少 {parameter1} 参数。
400	InvalidDBName_Duplicate	The specified DBName already exists.	数据库已存在。
400	TosRestoreTaskDbVerifyFailed	db verify failed, reason:%s.	DB 校验失败，原因是 {parameter1}。
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。
400	InvalidParameterFormat	The input parameter is not valid.	异常参数。
403	QuotaExceeded_RestoreDB	The quota of restore db exceeds.	恢复数据库超过配额限制。
403	OperationDenied_ResourceSoldOut	The requested resource is sold out in the specified zone; try other types of resources or other regions and zones.	当前可用区资源不足。
404	BackupNotFound	The specified instance does not exist available backup records.	未找到可用的备份记录。
404	InstanceNotFound	The specified instance does not exist.	未找到该实例。
500	InternalError	The request has failed with internal server error.	内部错误。
500	TosRestoreTaskNumExceedLimit	Too many tasks are being executed. Please submit them later.	正在执行的任务数量过多，请稍后再提交。

云数据库 SQL Server 版