文档首页/ 数据复制服务 DRS/ API参考/ 历史API/ API v3/ 公共接口管理/ 批量查询任务状态 - BatchListJobStatus
更新时间:2026-07-29 GMT+08:00

批量查询任务状态 - BatchListJobStatus

功能介绍

根据任务ID批量查询任务状态。

调试

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

授权信息

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

URI

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

表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列表,通过该参数指定需要查询的一个或多个任务。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

page_req

否

Object

参数解释:

分页信息。

详情请参见表4。

表4 page_req字段数据结构说明

参数

是否必选

参数类型

描述

cur_page

否

Integer

参数解释:

当前页码,用于分页查询时指定返回第几页的数据。填0可获取全部数据项。

约束限制:

  • 当per_page填0时,cur_page只能填0或1。

  • 不能超过传入jobID数量除每页任务数量的最大页。

取值范围:

不涉及。

默认取值:

1

per_page

否

Integer

参数解释:

每页返回的记录数,用于分页查询时控制每页数据量。填0可获取全部数据项。

约束限制:

  • 填0时,cur_page只能填0或1。

取值范围:

0-100。

默认取值:

5

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

results

Array of objects

参数解释:

任务状态信息。

详情请参见表6。

count

Integer

参数解释:

返回任务数量。

约束限制:

不涉及。

取值范围:

不涉及。

表6 results字段数据结构说明

参数

参数类型

描述

id

String

参数解释:

任务ID,用于标识查询结果对应的任务。

status

String

参数解释:

任务当前运行状态。

约束限制:

不涉及。

取值范围:

  • CREATING:创建中
  • CREATE_FAILED:创建失败
  • CONFIGURATION:配置中
  • STARTJOBING:启动中
  • WAITING_FOR_START:等待启动中
  • START_JOB_FAILED:启动失败
  • PAUSING:已暂停
  • FULL_TRANSFER_STARTED:全量开始,灾备场景下为初始化
  • FULL_TRANSFER_FAILED:全量失败,灾备场景下为初始化失败
  • FULL_TRANSFER_COMPLETE:全量完成,灾备场景下为初始化完成
  • INCRE_TRANSFER_STARTED:增量开始,灾备场景下为灾备中
  • INCRE_TRANSFER_FAILED:增量失败,灾备场景下为灾备异常
  • RELEASE_RESOURCE_STARTED:结束任务中
  • RELEASE_RESOURCE_FAILED:结束任务失败
  • RELEASE_RESOURCE_COMPLETE:已结束
  • REBUILD_NODE_STARTED:故障恢复中
  • REBUILD_NODE_FAILED:故障恢复失败
  • CHANGE_JOB_STARTED:任务变更中
  • CHANGE_JOB_FAILED:任务变更失败
  • DELETED:已删除
  • CHILD_TRANSFER_STARTING:再编辑子任务启动中
  • CHILD_TRANSFER_STARTED:再编辑子任务迁移中
  • CHILD_TRANSFER_COMPLETE:再编辑子任务迁移完成
  • CHILD_TRANSFER_FAILED:再编辑子任务迁移失败
  • RELEASE_CHILD_TRANSFER_STARTED:再编辑子任务结束中
  • RELEASE_CHILD_TRANSFER_COMPLETE:再编辑子任务已结束
  • NODE_UPGRADE_START:升级开始
  • NODE_UPGRADE_COMPLETE:升级完成
  • NODE_UPGRADE_FAILED:升级失败

error_code

String

参数解释:

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

约束限制:

不涉及。

取值范围:

格式为DRS.XXXXXX。

error_message

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

请求示例

批量查询任务状态示例:

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

{
  "jobs" : [ "9a470239-2308-4bb5-a6bc-1040402fjb21", "dc67695a-ee3e-49b8-a022-a099bd81jb21" ],
  "page_req" : {
    "cur_page" : 1,
    "per_page" : 10
  }
}

响应示例

状态码:200

OK

{
  "results" : [ {
    "id" : "9a470239-2308-4bb5-a6bc-1040402fjb21",
    "status" : "INCRE_TRANSFER_STARTED"
  }, {
    "id" : "dc67695a-ee3e-49b8-a022-a099bd81jb21",
    "status" : "INCRE_TRANSFER_FAILED"
  } ],
  "count" : 2
}

状态码

状态码

描述

200

OK

400

Bad Request

其他状态请参见状态码。

错误码

请参见错误码。