文档

CreateBackup - 为PolarDB集群创建全量快照备份

更新时间:

为PolarDB集群创建全量快照备份。

接口说明

说明
  • 每个集群最多可以同时存在 3 个手动创建的备份。
  • 若出现错误提示Exceeding the daily backup times of this DB cluster,表明您的集群中已存在 3 个手动创建的备份,请删除备份后再使用该接口。
  • 调用该接口后,会在后台创建备份任务,若数据量较大,花费的时间可能较长,请耐心等待。
  • 调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring

    集群 ID。

    pc-*************
    ClientTokenstring

    用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。

    6000170000591aed949d0f54a343f1a4233c1e7d1c5c******

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    F3322AFE-083E-4D77-A074-421301******
    BackupJobIdstring

    备份集 ID。

    11111111

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "F3322AFE-083E-4D77-A074-421301******",
      "BackupJobId": "11111111"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidBackupType.MalformedThe specified parameter BackupType is not valid.指定的参数BackupType无效。
    400InvalidBackupMethod.MalformedThe specified parameter BackupMethod is not valid.指定的参数BackupMethod无效。
    403BackupTimesExceededThe maximum number of backups per day is exceeded.操作失败,已超过集群每日备份次数上限(上限:3次)。
    404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 404 变更
      删除错误码:403
      新增错误码:400
    2022-03-25OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 404 变更
    2022-03-25OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:404
      新增错误码:403
    • 本页导读 (0)