tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RollbackInstance

Last updated: 2023-09-18 11:41:40

1. API Description

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

This API is used to roll back the instance by time point.

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: RollbackInstance.
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
Type Yes Integer Rollback type. 0: the database rolled back overwrites the original database; 1: the database rolled back is renamed and does not overwrite the original database
DBs.N Yes Array of String Database to be rolled back
Time Yes Timestamp Target time point for rollback
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 Rename the databases listed in ReNameRestoreDatabase. This parameter takes effect only when Type = 1 which indicates that backup rollback supports renaming databases. If it is left empty, databases will be renamed in the default format and the DBs parameter specifies the databases to be restored.

3. Output Parameters

Parameter Name Type Description
FlowId Integer The async job ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Rolling back the database by time point

This example shows you how to roll back the database by time point.

Input Example

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

{
    "InstanceId": "mssql-aj89iq78",
    "Type": 1,
    "DBs": [
        "abc"
    ],
    "Time": "2020-09-22 00:00:00",
    "TargetInstanceId": "mssql-aj89iq79",
    "RenameRestore": [
        {
            "OldName": "abc",
            "NewName": "abc"
        }
    ]
}

Output Example

{
    "Response": {
        "FlowId": 100023,
        "RequestId": "cd7a35be-2fbf-f3a6-210a-ea9afe158817"
    }
}

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.
InternalError.DBError Database error
InternalError.GcsError GCS API error.
InternalError.SystemError System error.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
InvalidParameterValue.DBCharIllegal The database name contains invalid characters.
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