Docs

RDS for PostgreSQL

Backup and recovery

RestoreToExistedInstance

Call the RestoreToExistedInstance API to restore data to an existing instance.

Request type

Asynchronous request.

Precautions

Currently, you can only restore data to an existing instance from a logical backup

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Required?	Example	Description
BackupId	String	Yes	20250512-194554-792LD	Backup ID used for restoration.
SourceDBInstanceId	String	Yes	postgres-a3e7eb2f****	Instance ID to which the backup belongs.
TargetDBInstanceId	String	Yes	postgres-a3e7eb2f****	Target instance ID for restoration. tip The values of SourceDBInstanceId and TargetDBInstanceId can be the same. If the values of SourceDBInstanceId and TargetDBInstanceId are the same, data will be restored to the source instance.
TargetDBInstanceAccount	String	Yes	Admin	The account that will serve as the owner of the newly restored database in the target instance. tip Only super accounts that are not disabled from DDL operations can be selected.
Databases	Array of RestoreDatabaseObject	Yes	Refer to the Sample response.	Information about the database to restore. tip You can choose up to 50 databases for recovery at a time.

RestoreDatabaseObject

Parameter	Type	Required?	Example	Description
DBName	String	Yes	DatabaseName	Original database name.
NewDBName	String	Yes	DatabaseName_restored	New database name. The database name must meet the following rules. If not met, the restoration task cannot be initiated. The name is unique within the instance. The name length is limited to 2–63 characters. The name must start with a letter and end with a letter or a digit. It consists of letters, digits, underscores (_), or hyphens (-). Some reserved words or keywords cannot be used in the database name. Refer to Reserved keywords for all reserved keywords.

Response parameters

null

Sample

Sample request

POST /?Action=RestoreToExistedInstance&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-postgresql.cn-beijing.volcengineapi.com​
X-Date: 20231002T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
    "BackupId": "20250512-194554-792LD",​
    "SourceDBInstanceId": "postgres-a3e7eb2f****",​
    "TargetDBInstanceId": "postgres-a3e7eb2f****",​
    "TargetDBInstanceAccount": "Admin",​
    "Databases": [​
        {​
            "DBName": "DatabaseName",​
            "NewDBName": "DatabaseName_restored"​
        }​
    ]​
}​

Sample response

{​
    "ResponseMetadata": {​
        "RequestId": "202505122228285485938EED274336A199-20bd59",​
        "Action": "RestoreToExistedInstance",​
        "Version": "2022-01-01",​
        "Service": "rds_postgresql",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

Last updated: 2026.03.31 10:45:19