文档首页/ 数据复制服务 DRS/ API参考/ API v3(推荐)/ 公共接口管理/ 批量查询任务进度 - BatchListProgresses
更新时间:2026-07-29 GMT+08:00
分享

批量查询任务进度 - BatchListProgresses

功能介绍

根据任务ID批量查询全量进度、增量时延信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v3/{project_id}/jobs/batch-progress

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

X-Auth-Token

String

参数解释

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制:

不涉及。

取值范围:

  • en-us:英语
  • zh-cn:中文

默认取值:

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

Array of strings

参数解释:

批量查询进度任务ID请求列表,通过该参数指定需要查询进度的一个或多个任务。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:

返回的任务进度信息总数,表示本次查询成功返回的任务数量,与results数组的长度一致。

约束限制:

不涉及。

取值范围:

不涉及。

results

Array of objects

参数解释:

批量查询迁移进度的响应体集合。

详情请参见表5

表5 results字段数据结构说明

参数

参数类型

描述

job_id

String

参数解释:

任务ID,用于唯一标识一个数据复制任务,在查询、修改、删除等操作中作为任务的识别凭证。

约束限制:

不涉及。

取值范围:

不涉及。

progress

String

参数解释:

迁移百分比,表示当前任务的数据迁移完成进度。

约束限制:

当progress为-1时代表任务还未进入迁移。

取值范围:

0-100。

incre_trans_delay

String

参数解释:

增量迁移时延,单位:s。当任务处于增量阶段时,该值表示源库与目标库之间的数据同步延迟。

约束限制:

当incre_trans_delay为-1时代表不处于增量阶段。

取值范围:

不涉及。

incre_trans_delay_millis

String

参数解释:

增量迁移时延,单位:ms。与incre_trans_delay含义相同,但以毫秒为单位提供更精确的时延信息。

约束限制:

当incre_trans_delay_millis为-1时代表不处于增量阶段。

取值范围:

不涉及。

task_mode

String

参数解释:

任务模式,指定数据复制任务的执行方式。

约束限制:

单主灾备场景仅支持选择FULL_INCR_TRANS(全量+增量)。

取值范围:

  • FULL_TRANS:全量,仅迁移历史数据,迁移完成后任务结束。
  • INCR_TRANS:增量,仅同步新增数据变更,适用于持续同步场景。
  • FULL_INCR_TRANS:全量+增量,先迁移历史数据再持续同步增量,适用于平滑切换场景。

transfer_status

String

参数解释:

任务当前传输状态,表示数据迁移任务所处的运行阶段,可用于判断任务是否正常推进。

约束限制:

不涉及。

取值范围:

  • CREATING:创建中
  • CREATE_FAILED:创建失败
  • CONFIGURATION:配置中
  • WAITING_FOR_START:等待启动中
  • RELEASE_RESOURCE_COMPLETE:已结束
  • DELETED:已删除
  • INCRE_TRANSFER_STARTED:增量迁移中
  • INCRE_TRANSFER_FAILED:增量迁移失败
  • FULL_TRANSFER_STARTED:全量迁移中
  • FULL_TRANSFER_COMPLETE:全量迁移完成
  • PAUSING:暂停中
  • FULL_TRANSFER_FAILED:全量迁移失败

process_time

String

参数解释:

迁移时间,格式为毫秒级Unix时间戳,表示任务最近一次进度更新时间。

约束限制:

不涉及。

取值范围:

不涉及。

remaining_time

String

参数解释:

预计剩余时间,单位为秒。

约束限制:

不涉及。

取值范围:

不涉及。

progress_map

Map<String>

参数解释:

数据,结构,索引迁移进度信息体。

详情请参见表6

error_code

String

参数解释:

错误码,当任务报错时返回的错误代码。

约束限制:

不涉及。

取值范围:

格式为DRS.XXXXXX。

error_msg

String

参数解释:

错误信息,当任务执行失败时返回的具体错误描述。

约束限制:

不涉及。

取值范围:

不涉及。

apply_rows_rate

Long

参数解释:

增量迁移RPS。

约束限制:

值为-1时代表任务尚未进入到增量状态。

取值范围:

不涉及。

apply_bytes_rate

Long

参数解释:

增量迁移网络流量。

约束限制:

值为-1时代表任务尚未进入到增量状态。

取值范围:

不涉及。

表6 progress_map字段数据结构说明

参数

参数类型

描述

completed

String

参数解释:

完成进度,以百分比形式表示,如"94%"、"100%"。

约束限制:

不涉及。

取值范围:

不涉及。

remaining_time

String

参数解释:

该子项任务的预计剩余时间。

约束限制:

不涉及。

取值范围:

不涉及。

请求示例

查询灾备进度示例:

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-progress

{
  "jobs" : [ "8d0e8e36-a618-490d-8a46-8c61ac9jb502" ]
}

响应示例

状态码:200

OK

  • 查询灾备进度响应示例 1:
    {
      "count" : 1,
      "results" : [ {
        "progress" : "100",
        "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502",
        "incre_trans_delay" : "0",
        "task_mode" : "FULL_INCR_TRANS",
        "transfer_status" : "INCRE_TRANSFER_STARTED",
        "process_time" : "1608274919000",
        "remaining_time" : "0"
      } ]
    }
  • 查询灾备进度响应示例 2:
    {
      "count" : 2,
      "results" : [ {
        "progress" : "100",
        "job_id" : "edae91cb-5892-49b6-a529-4921fb26jb21",
        "incre_trans_delay" : "0",
        "task_mode" : "FULL_INCR_TRANS",
        "transfer_status" : "INCRE_TRANSFER_STARTED",
        "process_time" : "1594864576000",
        "remaining_time" : "10"
      }, {
        "progress" : "0",
        "job_id" : "f95c5d83-d0c9-42bd-b295-38c31cd1jb15",
        "incre_trans_delay" : "-1",
        "task_mode" : "FULL_INCR_TRANS",
        "transfer_status" : "FULL_TRANSFER_COMPLETE",
        "process_time" : "0",
        "remaining_time" : "0",
        "progress_map" : {
          "struct" : {
            "completed" : "94%",
            "remaining_time" : null
          },
          "data" : {
            "completed" : "100%",
            "remaining_time" : null
          },
          "index" : {
            "completed" : "100%",
            "remaining_time" : null
          }
        }
      } ]
    }

状态码

状态码

描述

202

Accepted

400

Bad Request

其他状态请参见状态码

错误码

请参见错误码

相关文档