云数据库 PostgreSQL 版
云数据库 PostgreSQL 版
云数据库 PostgreSQL 版
文档指南
请输入
产品动态
用户指南
实例管理
连接管理
服务可用性
Schema 管理
备份恢复
日志管理
数据安全
插件
API 参考
V2（2022-01-01）
实例管理
账号管理
连接管理
参数管理
备份与恢复
数据安全
SDK 参考
V2（2022-01-01）
相关协议
- 文档首页
云数据库 PostgreSQL 版API 参考V2（2022-01-01）备份与恢复CreateBackup
复制全文
下载 pdfCreateBackup
文档反馈
问问助手调用 CreateBackup 接口创建数据备份。
请求类型
异步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 是 | postgres-21a3333b**** | 实例 ID。 |
BackupScope | String | 否 | Database | 备份对象。取值：
|
BackupMethod | String | 否 | Logical | 备份类型。取值：
说明 当 BackupScope 取值为 Database 时，BackupMethod 只能取值 Logical。 |
BackupType | String | 否 | Full | 备份类型，取值：
|
BackupDescription | String | 否 | This is a description of the backup set. | 添加备份集的描述信息，便于后续管理备份。最多支持 256 个字符。 |
BackupMeta | 否 | 请参见请求示例。 | 指定需要备份的库。 说明 仅在 BackupScope 的取值为 Database时支持设定该参数。 |
BackupMetaObject
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
DBName | String | 是 | database1 | 需要备份的数据库的名称。 说明
|
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
BackupId | String | 20250512-180204-3157LD | 备份 ID。 说明 仅在 BackupMethod 的取值为 Logical 时支持设定该参数。当 BackupMethod 的取值为 Physical 时，返回为 null。 |
示例
请求示例
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"
}
]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230804111113B068599C4088F905B8EB",
"Action": "CreateBackup",
"Version": "2022-01-01",
"Service": "rds_postgresql",
"Region": "cn-beijing"
},
"Result": {
"BackupId": "20250512-194654-3836LI"
}
}
最近更新时间：2026.04.22 21:11:47
这个页面对您有帮助吗？
有用
有用
无用
无用