tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RestoreInstance

Last updated: 2024-11-26 16:31:22

    1. API Description

    Domain name for API request: sqlserver.intl.tencentcloudapi.com.

    This API is used to roll back the database by backup set.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    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 Params. The value used for this API: RestoreInstance.
    Version Yes String Common Params. The value used for this API: 2018-03-28.
    Region Yes String Common Params. 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.
    Type No Integer Rollback type. Valid values: 0 (overwriting), 1 (renaming).
    DBList.N No Array of String Database to be overwritten, which is required when overwriting a rollback database.
    GroupId No String Group ID of unarchived backup files grouped by backup task

    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 unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Rolling back the database by backup set

    This example shows you how to roll back the database by backup set.

    Input Example

    POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RestoreInstance
<Common request parameters>

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

    Output Example

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

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

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

    Error Code Description
    FailedOperation.DBError Database error.
    FailedOperation.GcsError The operation failed or the network timed out.
    InternalError.DBError Database error
    InternalError.SystemError System error.
    InvalidParameter.InputIllegal Input error.
    InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
    InvalidParameterValue.DBExist The database already exists.
    LimitExceeded.TooManyDB The database limit is exceeded.
    ResourceNotFound.DBNotFound The database does not exist.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    ResourceUnavailable.DBInvalidStatus Invalid database status.
    ResourceUnavailable.InstanceStatusInvalid Invalid instance status.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy