调用CreateBackup接口为实例创建一个备份集。

本接口调用的是RDS自带的备份功能接口，您也可以使用数据库备份DBS。更多信息，请参见DBS API概览。

调用该接口时，实例必须满足以下条件，否则将操作失败：

  • 实例状态为运行中。
  • 没有正在执行中的备份任务。
  • 单个实例一天内可创建的备份集数量不超过20个。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateBackup

系统规定参数，取值：CreateBackup。

DBInstanceId String 是 rm-uf6wjk5xxxxxxx

实例ID。
DBName String 否 rds_mysql

数据库列表，多个数据库之间用英文逗号（,）隔开。

说明 MySQL进行单库逻辑备份或SQL Server进行单库全量物理备份时可传入该参数。
BackupStrategy String 否 db

备份策略，取值：

  • db：单库备份
  • instance：实例备份
说明 MySQL进行逻辑备份或SQL Server进行全量物理备份时可传入该参数。
BackupMethod String 否 Physical

备份类型，取值：

  • Logical：逻辑备份
  • Physical：物理备份
  • Snapshot：快照备份

默认值：Physical。

说明
  • 实例必须存在数据库才能进行逻辑备份。
  • MariaDB实例进行快照备份时请填写Physical。
  • 实例支持的备份类型请参见备份数据。
  • SQL Server云盘实例进行快照备份时请填写Snapshot。
BackupType String 否 Auto

备份方式，取值：

  • Auto：自动选择全量备份或增量备份
  • FullBackup：全量备份

默认值：Auto。

说明
  • 仅SQL Server需要填写此参数，其他引擎不用填写。
  • 该值仅在BackupMethod参数为Physical时有效。

返回数据

名称 类型 示例值 描述
BackupJobId String 5073731

备份任务ID。
RequestId String 2C125605-266F-41CA-8AC5-3A643D4F42C5

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=CreateBackup
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<公共请求参数>

正常返回示例

XML格式 

<CreateBackupResponse>
	  <RequestId>2C125605-266F-41CA-8AC5-3A643D4F42C5</RequestId>
	  <BackupJobId>5073731</BackupJobId>
</CreateBackupResponse>

JSON格式 

{
    "RequestId": "2C125605-266F-41CA-8AC5-3A643D4F42C5", 
    "BackupJobId": "5073731"
}

错误码

访问错误中心查看更多错误码。