RDS for SQL Server
RDS for SQL Server
Document
- Documentation
RDS for SQL ServerAPI referenceBackupRestoreToExistedInstance - Restore to an existing instance
Copy page
Download PDFBackup
RestoreToExistedInstance - Restore to an existing instance
Copy pageDownload PDFRestoreToExistedInstance - Restore to an existing instance
Call the RestoreToExistedInstance API to restore databases to an existing instance.
Precautions
The following limitations apply to data recovery based on the compatible version of the instance:
- When the source instance is a Web edition (`DBEngineVersion`: SQLServer_2019_Web), it can be restored to an Enterprise, Standard, or Web edition instance (`DBEngineVersion`: SQLServer_2019_Std, SQLServer_2019_Ent, or SQLServer_2019_Web).
- When the source instance is a Standard edition (`DBEngineVersion`: SQLServer_2019_Std), it can be restored to an Enterprise or Standard edition instance (`DBEngineVersion`: SQLServer_2019_Std or SQLServer_2019_Ent).
- When the source instance is an Enterprise edition (`DBEngineVersion`: SQLServer_2019_Ent), it can be restored to an Enterprise edition instance (`DBEngineVersion`: SQLServer_2019_Ent).
Request parameters
Only the request parameters specific to this API and some common parameters are listed below. For more information, see Common parameters.
Action string Example value: RestoreToExistedInstance
The action to perform. The value is RestoreToExistedInstance.
Version string Example value: 2022-01-01
API version. The value is 2022-01-01.
SourceDBInstanceId string Example value: mssql-bbe31c86****
Source instance ID.
tip
TargetDBInstanceId string Example value: mssql-bbe31c86****
The target instance ID.
tip
- You can call the DescribeDBInstances API to query the instance ID.
- If this ID is the same as the source instance ID, the data is restored to the source instance.
Databases object[] Example value: None
Information on the databases to restore.
tip
You can specify up to 100 databases.
DBName string Example value: test
Original database name.
NewDBName string Optional. Example: test_bak
New database name. Naming rules are as follows:
- Start with a letter and end with a letter or digit.
- The length must be between 2 and 60 characters.
- Consists of letters, numbers, and underscores (_), and is case-insensitive.
- Do not use reserved words such as master, msdb, model, tempdb, resource, rdsadmin, and distribution.
tip
When creating a TOS backup recovery task with the CreateTosRestore API, note the following:
- If this parameter is not configured, the original database name is used by default.
- When this parameter is set, the new database name can not be the same as an existing one if BackupType is Full, and it must already exist if BackupType is Diff or LOG.
BackupId string Optional. Example value: f569f53bf60a48d5b****
The backup set ID of the source instance.
tip
- When restoring a database from a backup set, you can obtain the BackupId by calling DescribeBackups.
- Provide either BackupId or RestoreTime.
RestoreTime string Optional. Example: 2023-08-23T08:04:59Z
Restore the database to a point in time. You can select any point in time within the backup retention period. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
tip
Provide either BackupId or RestoreTime.
Response parameters
Only the response parameters for this API are listed below. For more information, see Response structure.
InstanceId string Example: mssql-1be522b5****
Source instance ID.
Request example 1
POST /?Action=RestoreToExistedInstance&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.cn-beijing.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"SourceDBInstanceId":"mssql-1be522b5****",
"TargetDBInstanceId":"mssql-1be522b5****",
"RestoreTime":"2023-08-23T08:04:59Z",
"Databases":[{
"DBName":"tets1",
"NewDBName":"tewy222"
}]
}
Response example 1
{
"ResponseMetadata": {
"RequestId": "20230823161248951129B6A9EC3C53ELLD",
"Action": "RestoreToExistedInstance",
"Version": "2022-01-01",
"Service": "rds_mssql",
"Region": "cn-beijing"
},
"Result": {
"InstanceId": "mssql-1be522b5****"
}
}
Request example 2
POST /?Action=RestoreToExistedInstance&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
"SourceDBInstanceId":"mssql-1be522b5****",
"TargetDBInstanceId":"mssql-1be522b5****",
"BackupId": "94fe801db98d41848197266ecaecc878",
"Databases":[{
"DBName":"tets1",
"NewDBName":"tjy3"
}]
}
Response example 2
{
"ResponseMetadata": {
"RequestId": "2023082316124895D97DB6A9EC3C53E9EC",
"Action": "RestoreToExistedInstance",
"Version": "2022-01-01",
"Service": "rds_mssql",
"Region": "cn-beijing"
},
"Result": {
"InstanceId": "mssql-1be522b5****"
}
}
Error code
The table below lists the error codes for this API's business logic. For public error codes, see the Public Error Codes document.
Last updated: 2026.02.11 15:34:54
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
