Help & DocumentationAPIsTencentDB for SQL ServerInstance Management APIsRestoreInstance

RestoreInstance

Last updated: 2019-09-09 14:59:26

Contents：

1. API Description

API domain name: sqlserver.tencentcloudapi.com.

This API (RestoreInstance) restores the specified baked-up instance.

API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The name of this API: RestoreInstance
Version Yes String Common parameter. The version of this API: 2018-03-28
Region Yes String Common parameter. For more information, see the list of regions supported by the product.
InstanceId Yes String Instance ID, for example, mssql-j8kv137v
BackupId Yes Integer Backup file ID, which can be obtained through the Id field in the return of the DescribeBackups API

3. Output Parameters

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 ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Restoring an Instance

Input Sample Code

https://sqlserver.tencentcloudapi.com/?Action=RestoreInstance
&InstanceId=mssql-njj2mtpl
&BackupId=32687264876
&<Common request parameter>

Output Sample Code

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

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InternalError.SystemError System error.
InvalidParameter.InputIllegal Invalid input.
InvalidParameter.ParamsAssertFailed Parameter assertion conversion error.
ResourceNotFound.InstanceNotFound The instance does not exist.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.