异步任务进度查询
功能介绍
该接口为扩展接口,主要用于查询异步任务进度。
请求示例
异步任务进度查询。
GET /v1/cloudimages/job/ff8080814dbd65d7014dbe0d84db0013
响应消息
- 响应参数
参数
参数类型
描述
job_id
String
任务ID。
job_type
String
任务类型。
- imsCreateImageByInstance:云服务器创建镜像
- imsImportImageJob:外部镜像文件创建镜像
- imsImportOvaImageJob:外部Ova镜像文件创建镜像
- imsVolumeCreateImageJob:数据盘创建系统盘镜像
- imsVolumesToSysDataImagesJob:数据盘创建数据盘镜像
- imsImportDataImageJob:外部镜像文件创建数据盘镜像
- imsCreateWholeImageByInstanceJob:云服务器创建整机镜像
- imsCreateWholeImageByBackupJob:云备份或云服务器备份创建整机镜像
- imsNativeImportImageJob:注册镜像
- imsNativeExportImageJob:导出镜像
- imsAddImageMembersJob:添加镜像成员
- imsDelImageMembersJob:删除镜像成员
- imsUpdateImageMembersJob:修改镜像成员
- imsCopyImageInRegionJob:Region内复制镜像
- imsCrossRegionCopyImageJob:跨Region复制镜像
begin_time
String
任务开始执行时间。格式为UTC时间。
end_time
String
任务结束时间。格式为UTC时间。
status
String
任务状态,目前取值如下:
- SUCCESS:表示该任务执行已经结束,任务执行成功。
- FAIL:表示该任务执行已经结束,任务执行失败。
- RUNNING:表示该任务正在执行。
- INIT:表示该任务还未执行,正在初始化。
error_code
String
错误码。
fail_reason
String
失败原因。
entities
Object
任务自定义属性。
任务正常时,返回镜像的ID;任务异常时,返回错误码和信息。
详情请参见表2。
表2 entities字段数据结构说明 参数
参数类型
描述
image_name
String
镜像名称。
process_percent
Double
任务执行进度。
current_task
String
当前任务名称。
subJobId
String
子任务ID。
image_id
String
镜像ID。
sub_jobs_result
Array of SubJobResult objects
子任务执行结果。详情请参见表3。
sub_jobs_list
Array of string
子任务id列表。
表3 SubJobResult字段数据结构说明 参数
参数类型
描述
status
String
子任务状态,取值如下:
- SUCCESS:表示该任务执行已经结束,任务执行成功。
- FAIL:表示该任务执行已经结束,任务执行失败。
- RUNNING:表示该任务正在执行。
- INIT:表示该任务还未执行,正在初始化。
job_id
String
子任务ID。
job_type
String
子任务类型。
begin_time
String
子任务开始执行时间。格式为UTC时间。
end_time
String
子任务结束时间。格式为UTC时间。
error_code
String
错误码。
fail_reason
String
失败原因。
entities
Object
子任务自定义属性。详情请参见表4
- 任务正常时,返回镜像的ID。
- 任务异常时,返回错误码和信息。
- 响应样例
STATUS CODE 200
{ "job_id": "ff80808280c204e30180d2784c3c0d86", "job_type": "imsCopyImageInRegionJob", "begin_time": "2022-05-17T14:42:20.859Z", "end_time": "", "status": "RUNNING", "error_code": null, "fail_reason": null, "entities": { "image_name": "d0d2e701-dfc4-4520-9247-f92907f38eb0", "process_percent": 0.40, "current_task": "CopyImageInRegionTask:", "subJobId": "ff80808280ca6cd30180d278b9db0221", "image_id": "498cc67e-7795-482c-8c47-32bcece2d7ec" } }