文档首页/ 数据复制服务 DRS/ API参考/ API v3（不再推广）/ 公共接口管理/ 批量查询任务状态
更新时间：2023-09-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量查询任务状态

功能介绍

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

指定类型为application/json。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。

X-Language

否

String

请求语言类型。

缺省值：en-us

取值：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

是

Array of strings

批量查询任务详情。

page_req

否

Object

分页信息。

详情请参见表4。
表4 page_req字段数据结构说明

参数

是否必选

参数类型

描述

cur_page

否

Integer

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

  • 最小值：1
  • 缺省值：1

per_page

否

Integer

每页item数量，填0获取全部item。

  • 最小值：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：升级失败

枚举值：

  • 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

错误码。

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

错误码

请参见错误码。

父主题： 公共接口管理