文档

CreateBackup - 手动备份实例

创建MongoDB实例备份。

接口说明

调用 CreateBackup 接口时,实例状态必须为运行中。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

d-bp2235****
BackupMethodstring

实例的备份方式,取值:

  • Snapshot:快照备份。
  • Logical:逻辑备份。
  • Physical(默认值):物理备份。
说明
  • 云盘版实例仅支持快照备份。
  • 仅副本集和分片集群实例支持选择备份方式。单节点实例无需传入本参数,固定为快照备份。
  • Logical

    返回参数

    名称类型描述示例值
    object

    返回数据。

    BackupIdstring

    备份 ID。

    说明 该参数即将下线,如需获取备份 ID,请调用 DescribeBackups 接口获取。
    5664****
    RequestIdstring

    请求 ID。

    7016B12F-7F64-40A4-BAFF-013F02AC82FC

    示例

    正常返回示例

    JSON格式

    {
      "BackupId": "5664****",
      "RequestId": "7016B12F-7F64-40A4-BAFF-013F02AC82FC"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidBackupMethod.ValueNotSupportThe specified parameter BackupMethod is not valid.-
    403OperationDenied.BackupJobExistsThe operation is not permitted due to backup job exist.当前有正在进行的备份任务,请稍后再试。
    403OperationDenied.NoDatabaseThe operation is not permitted due to no database.-

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

    变更历史

    变更时间变更内容概要操作
    2023-12-07OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
    • 本页导读 (1)
    文档反馈