CreateBackup--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

CreateBackup

最近更新时间：2025.06.10 11:39:05首次发布时间：2023.11.15 22:39:51

调用 CreateBackup 接口创建数据备份。

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-21a3333b****	实例 ID。
BackupScope	String	否	Database	备份对象。取值： `Instance`：整个实例。默认值。 `Database`：指定库。
BackupMethod	String	否	Logical	备份类型。取值： `Physical`：物理备份。默认值。 `Logical`：逻辑备份。说明当 BackupScope 取值为 `Database` 时，BackupMethod 只能取值 `Logical`。
BackupType	String	否	Full	备份类型，取值： `Full`：全量备份（默认）。 `Increment`：增量备份。
BackupDescription	String	否	This is a description of the backup set.	添加备份集的描述信息，便于后续管理备份。最多支持 256 个字符。
BackupMeta	Object[]	否	请参见请求示例。	指定需要备份的库。说明仅在 BackupScope 的取值为 `Database` 时支持设定该参数。

返回参数

参数	类型	示例值	描述
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"
    }
}