批量查询任务进度 - 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	指定类型为application/json。缺省值：application/json
X-Auth-Token	是	String	从IAM服务获取的用户Token。
X-Language	否	String	请求语言类型。取值范围： en-us：英语 zh-cn：中文缺省值：en-us

表3 请求Body参数
参数	是否必选	参数类型	描述
jobs	是	Array of strings	批量查询进度任务ID请求列表。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
count	Integer	总数。
results	Array of objects	批量查询迁移进度的响应体集合。详情请参见表5。

表5 results字段数据结构说明
参数	参数类型	描述
job_id	String	任务ID。
progress	String	迁移百分比。
incre_trans_delay	String	增量迁移时延，单位：s。
incre_trans_delay_millis	String	增量迁移时延，单位：ms。
task_mode	String	任务模式。取值范围： FULL_TRANS：全量 INCR_TRANS：增量 FULL_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	迁移时间，时间戳。
remaining_time	String	预计剩余时间。
progress_map	Map<String,ProgressInfo>	数据，结构，索引迁移进度信息体。详情请参见表6。
error_code	String	错误码。
error_msg	String	错误信息。

表6 progress_map字段数据结构说明
参数	参数类型	描述
completed	String	完成进度。
remaining_time	String	预计剩余时间。

请求示例

查询灾备进度示例：

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

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

响应示例

状态码：200

查询灾备进度响应示例 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
      }
    }
  } ]
}