全部产品
Search

搜索本产品

    云数据库 MongoDB：DescribeBackupTasks - 查询实例进行中的备份任务

    文档中心

    云数据库 MongoDB：DescribeBackupTasks - 查询实例进行中的备份任务

    更新时间：Nov 07, 2024

    查询MongoDB云盘版副本集或分片集进行中的备份任务。

    调试

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

    授权信息

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

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

    请求参数

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

    实例 ID。

    		dds-2zeb2d64cb46xxxx
    BackupJobIdstring否

    备份任务 ID。

    说明 如果您调用 CreateBackup 执行了手动备份，您可以将返回的备份 ID 传入，用以查询备份的进度。
    		170034

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

    		D648B367-15B6-1B42-BD4B-47507C9CC****
    BackupJobsarray<object>

    备份任务详情。

    BackupTaskobject

    备份任务详情。

    BackupjobIdstring

    备份任务 ID。

    		170034
    BackupSetStatusstring

    备份任务状态。

    • Scheduled：计划中备份任务，包括未开始的常规备份任务。
    • Checking：备份前实例检查。
    • Backuping：备份中。
    • Finished：备份完成。
    		Scheduled
    BackupStartTimestring

    备份开始时间。

    		2024-01-16T11:04:56Z
    Progressstring

    备份进度，单位为%。 仅正在运行的备份才会显示进度。

    		18%
    JobModestring

    备份模式，返回值：

    • Automated：系统自动备份。
    • Manual：手动备份。
    		Manual

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "D648B367-15B6-1B42-BD4B-47507C9CC****",
  "BackupJobs": [
    {
      "BackupjobId": "170034\n",
      "BackupSetStatus": "Scheduled",
      "BackupStartTime": "2024-01-16T11:04:56Z",
      "Progress": "18%",
      "JobMode": "Manual"
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-04-12OpenAPI 返回结构发生变更查看变更详情