tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RestoreDBInstanceObjects

Last updated: 2024-06-17 14:26:30

1. API Description

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

This API is used to recover database-related objects such as databases and tables on the original instance based on the backup set or recovery target time.

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: RestoreDBInstanceObjects.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
DBInstanceId Yes String Instance ID.
RestoreObjects.N Yes Array of String List of objects to be restored. If the object to be restored is named test, the restored name will be test_bak_${LinuxTime}. ${LinuxTime} cannot be specified and is set by the system based on the Linux time at task initiation.
BackupSetId No String Backup set used for recovery. Either BackupSetId or RestoreTargetTime must be provided, and only one can be passed.
RestoreTargetTime No String Recovery target time, Beijing Time (UTC+8). Either BackupSetId or RestoreTargetTime must be provided, and only one can be passed.

3. Output Parameters

Parameter Name Type Description
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 Specifying Recovery Time and Recovering Database Objects

This example shows you how to specify a recovery time on the original instance to restore certain database-related objects. For example, on the postgres-abcd1234 instance, restore the test database at the recovery point of 2024-03-25 01:27:35.

Input Example

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

{
    "DBInstanceId": "postgres-abcd1234",
    "RestoreTargetTime": "2024-03-25 01:27:35",
    "RestoreObjects": [
        "test"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90"
    }
}

Example2 Selecting a Backup Set and Recovering Database Objects

This example shows you how to select a backup set on the original instance to restore certain database-related objects. For example, on the postgres-abcd1234 instance, use the backup set 28aa61ac-1b1f-566a-bedb-6e918024be02 to restore the test database.

Input Example

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

{
    "DBInstanceId": "postgres-abcd1234",
    "BackupSetId": "28aa61ac-1b1f-566a-bedb-6e918024be02",
    "RestoreObjects": [
        "test"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "3d49f48c-7d27-4820-8724-ed5b15787373"
    }
}

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.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
FailedOperation.FlowCreateError Failed to create a task. Please try again later. If the problem persists, please contact customer service.
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
OperationDenied.InstanceStatusLimitError This operation cannot be performed on an instance in this status.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy