备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 备份 CreateBackup - 为RDS实例创建备份集

CreateBackup - 为RDS实例创建备份集

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

该接口用于为RDS实例创建一个备份集。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

功能说明

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

注意事项

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

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

相关功能文档

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:CreateBackupWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
无

请求参数

名称类型必填描述示例值
DBInstanceIdstring是

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
DBNamestring否

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

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

备份策略，取值：

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

备份类型，取值：

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

默认值：Physical。

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

    备份方式，取值：

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

    默认值：Auto。

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

    资源组 ID。可调用 DescribeDBInstanceAttribute 获取。

    		rg-acfmy****

    返回参数

    名称类型描述示例值
    object

    返回参数详情。

    BackupJobIdstring

    备份任务 ID。

    		507****
    RequestIdstring

    请求 ID。

    		2C125605-266F-41CA-8AC5-3A643D4F42C5

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400BackupType.NotSupportthe specified backup type not support指定的备份类型不受支持。
    400InvalidBackupMethod.ValueNotSupportThe specified parameter "BackupMethod" is not valid.备份方法无效，请重新选择备份方法。 备份方法分为：逻辑备份（Logical）和物理备份（Physical），默认值为Physical。 逻辑备份不支持没有数据库的实例；SQLServer仅支持物理备份。
    400ReadDBInstanceNotSupportThe operation is not permitted due to type of the instance.只读实例不允许执行该操作。
    400IncorrectDBInstanceLockMode.ValueNotSupportedThe Current DB instance lock mode does not support this operation.操作失败，当前数据库实例锁模式不支持此操作。
    400BackupJobExistsA backup job already exists in the specified DB instance.备份已存在。
    400InvalidPreferredBackupTime.FormatSpecified preferred backup time is not valid.期望备份日期的格式不正确。格式要求为标准GMT格式，即YYYY-MM-DDThh:mmZ。例如：2012-06-11T15:00Z
    400InvalidDBName.FormatSpecified DB name is not valid.无效的数据库名称。请重新命名，数据库名称由小写字母，数字、下划线组成，字母开头，字母或数字结尾，最长16个字符。
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
    400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
    400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
    400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
    400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法，请重新购买。
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
    400Price.CommoditySysCommodity system call exception.商品系统调用异常。
    400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题，请重新选购。
    400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单，请支付或作废后再下单。
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善，请在操作前先完善您的基本信息。
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常，详情请联系客服。
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整，请在操作前填写您的信息。
    400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
    403OperationDenied.ApiForbiddenoperation not permitted.当前操作不被允许。
    403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败，数据库引擎不支持。
    403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.操作失败，当前数据库实例引擎和类型不支持。
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
    403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.当前DB实例字符类型不支持此操作。
    403Exceeded.BackupTimesThe backup times exceeds.指定的BackupTimes信息无效
    403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。
    404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。
    404InvalidDB.NotFoundSpecified db does not exist or DB status does not support this operation.操作失败，当前实例下没有数据库或数据库状态不支持该操作。您可以调用DescribeDatabases接口查看实例下的数据库列表，检查数据库是否存在。

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

    变更历史

    变更时间变更内容概要操作
    2022-10-28OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 400 变更
      错误码 403 变更
      新增错误码：404
    文档推荐
    • 本页导读 （1）
    文档反馈