Domain name for API request: sqlserver.tencentcloudapi.com.
This API is used to restore an instance from a backup file.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: sqlserver.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: RestoreInstance. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-03-28. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID in the format of mssql-j8kv137v |
| BackupId | Yes | Integer | Backup file ID, which can be obtained through the Id field in the returned value of the DescribeBackups API |
| TargetInstanceId | No | String | ID of the target instance to which the backup is restored. The target instance should be under the same APPID. If this parameter is left empty, ID of the source instance will be used. |
| RenameRestore.N | No | Array of RenameRestoreDatabase | Restore the databases listed in ReNameRestoreDatabase and rename them after restoration. If this parameter is left empty, all databases will be restored and renamed in the default format. |
| Parameter Name | Type | Description |
|---|---|---|
| FlowId | Integer | Async flow task ID, which can be used to call the DescribeFlowStatus API to get the task execution status |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://sqlserver.tencentcloudapi.com/?Action=RestoreInstance
&InstanceId=mssql-njj2mtpl
&BackupId=32687264876
&<Public request parameters>{
"Response": {
"RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
"FlowId": 3546
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.DBError | Database error |
| InternalError.SystemError | System error. |
| InvalidParameter.InputIllegal | Input error. |
| InvalidParameter.ParamsAssertFailed | An error occurred while converting parameter assertion. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceUnavailable.InstanceStatusInvalid | Invalid instance status. |
| UnauthorizedOperation.PermissionDenied | CAM authentication error. |
Was this page helpful?