DescribeDBRestoreTime

下载PDF

最后更新时间：2025-10-28 22:48:54

DescribeDBRestoreTime

最后更新时间： 2025-10-28 22:48:54

下载PDF

1. API Description

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

This API is used to query databases that can be rolled back.

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: DescribeDBRestoreTime.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	Original instance ID.
TargetInstanceId	No	String	ID of the target instance for rollback. If this parameter is left unspecified, roll back to the original instance by default.
Time	No	String	Queries databases that can be rolled back by time point, with the time format of YYYY-MM-DD HH:MM:SS. Either BackupId or Time should be specified, as they cannot be empty simultaneously.
BackupId	No	Integer	Queries databases that can be rolled back by backup set ID, which can be obtained through the DescribeBackups API. Either BackupId or Time should be specified, as they cannot be empty simultaneously.
DBName	No	String	Database name.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of databases that can be rolled back.
Details	Array of DBRenameRes	List of databases that can be rolled back.
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 Query Databases That Can Be Rolled Back

This example shows you how to query databases that can be rolled back.

Input Example

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

{
    "InstanceId": "mssql-quw892ks",
    "TargetInstanceId": "mssql-quw892ks",
    "Time": "2023-04-11 12:00:00",
    "BackupId": 0,
    "DBName": "test_db"
}

Output Example

{
    "Response": {
        "Details": [
            {
                "NewName": "new_db_test",
                "OldName": "db_test"
            }
        ],
        "RequestId": "424e1df0-9253-11ed-8d88-ffd89b85f329",
        "TotalCount": 1
    }
}

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

Tencent Cloud CLI 3.0

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.
InvalidParameter.InputIllegal	Input error.
ResourceNotFound.InstanceNotFound	The instance does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud