RDS for PostgreSQL
RDS for PostgreSQL
RDS for PostgreSQL
Document
What's new
Product announcement
Overview
Billing
Quick start
User guide
Managing instances
Modifying the specification
Managing tags
Managing connections
Connecting to an instance
Managing connection endpoints
Service availability
Managing accounts
Managing databases
Managing schemas
Monitoring and alerts
Backup recovery
Data backup
Managing logs
Data security
Managing the allowlist (new version)
Configuring SSL encryption
Configuring parameters
Operation and maintenance events
Task center
Extensions
API reference
V2(2022-01-01)
Managing instances
Managing accounts
Managing schemas
Managing connections
Managing parameters
Backup and recovery
Managing logs
Event management
Data security
Task management
SDK reference
Developer tool
Best practices
Performance document
FAQs
Terms
- Documentation
RDS for PostgreSQL API referenceV2(2022-01-01)Backup and recoveryCreateBackup
Copy page
Download PDFBackup and recovery
CreateBackup
Copy pageDownload PDFCreateBackup
Call the CreateBackup API to create a data backup.
Request type
Asynchronous request.
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.
Request parameters
Parameter | Type | Required? | Example | Description |
Parameter | Type | Required? | Example | Description |
InstanceId | String | Yes | postgres-21a3333b**** | Instance ID. |
BackupScope | String | No | Database | Backup target. Values:
|
BackupMethod | String | No | Logical | Backup type. Values:
tip When BackupScope is set to Database, BackupMethod can only be set to Logical. |
BackupType | String | No | Full | Backup type, values:
|
BackupDescription | String | No | This is a description of the backup set. | Add a description of the backup set for subsequent management of backups. Supports up to 256 characters. |
BackupMeta | No | Refer to the request example. | Specify databases to back up. tip This parameter is supported only when BackupScope is set to Database. |
BackupMetaObject
Parameter | Type | Required? | Example | Description |
Parameter | Type | Required? | Example | Description |
DBName | String | Yes | database1 | Name of the database to be backed up. tip
|
Response parameters
Parameter | Type | Example | Description |
Parameter | Type | Example | Description |
BackupId | String | 20250512-180204-3157LD | Backup ID. tip This parameter is supported only when BackupMethod is set to Logical. When SlotType is set to physical, this field returnsnull。 |
Sample
Sample request
POST /?Action=CreateBackup&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****
{
"InstanceId": "postgres-21a3333b****",
"BackupScope": "Database",
"BackupMethod": "Logical",
"BackupDescription": "This is a description of the backup set.",
"BackupMeta": [
{
"DBName": "database1"
}
]
}
Sample response
{
"ResponseMetadata": {
"RequestId": "20230804111113B068599C4088F905B8EB",
"Action": "CreateBackup",
"Version": "2022-01-01",
"Service": "rds_postgresql",
"Region": "cn-beijing"
},
"Result": {
"BackupId": "20250512-194654-3836LI"
}
}
Last updated: 2026.04.22 21:12:00
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
