文档

DescribeBackupTasks - 查询实例进行中的备份任务

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

实例 ID。

dds-2zeb2d64cb46xxxx
BackupJobIdstring

备份任务 ID。

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

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

D648B367-15B6-1B42-BD4B-47507C9CC****
BackupJobsobject []

备份任务详情。

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 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈