异步任务查询
功能介绍
该接口为扩展接口,主要用于查询异步接口执行情况,比如查询导出镜像任务的执行状态。
请求消息
请求参数
无
请求示例
查询异步接口执行情况。
GET /v1/ac234de25c6741d2b1273da49eea1b9e/jobs/ff8080814dbd65d7014dbe0d84db0013
响应消息
- 响应参数
参数
参数类型
描述
status
String
任务状态,目前取值如下:
- SUCCESS:表示该任务执行已经结束,任务执行成功。
- FAIL:表示该任务执行已经结束,任务执行失败。
- RUNNING:表示该任务正在执行。
- INIT:表示该任务还未执行,正在初始化。
job_id
String
任务ID。
job_type
String
任务类型。
- imsCreateImageByInstance:云服务器制作镜像
- imsImportImageJob:外部镜像文件创建镜像
- imsImportOvaImageJob:外部Ova镜像文件创建镜像
- imsVolumeCreateImageJob:数据盘制作数据盘镜像
- imsImportDataImageJob:外部镜像文件制作数据盘镜像
- imsCreateWholeImageByInstanceJob:云服务器制作整机镜像
- imsCreateWholeImageByBackupJob:云备份或云服务器备份制作整机镜像
- imsNativeImportImageJob:注册镜像
- imsNativeExportImageJob:导出镜像
- imsAddImageMembersJob:添加镜像成员
- imsDelImageMembersJob:删除镜像成员
- imsUpdateImageMembersJob:修改镜像成员
- imsCopyImageInRegionJob:Region内复制镜像
- imsCopyImageCrossUserJob:跨Region复制镜像
begin_time
String
任务开始执行时间。格式为UTC时间。
end_time
String
任务结束时间。格式为UTC时间。
error_code
String
错误码。
fail_reason
String
失败原因。
entities
Object
任务自定义属性。
任务正常时,返回镜像的ID;任务异常时,返回错误码和信息。
详情请参见表2。
表2 entities字段数据结构说明 参数
参数类型
描述
image_id
String
镜像ID。
current_task
String
当前任务名称。
image_name
String
镜像名称。
process_percent
Double
任务执行进度。
results
Array of result objects
批量任务执行结果。详情请参见表3。
sub_jobs_result
Array of objects
子任务执行结果。详情请参见表4。
sub_jobs_list
Array of string
子任务id列表。
addition_error_code
string
添加错误码
addition_error_msg
string
添加错误消息
error_code
string
错误码
error
string
错误消息
alarm_code
string
告警代码
表4 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
子任务自定义属性。详情请参见表5
- 任务正常时,返回镜像的ID。
- 任务异常时,返回错误码和信息。
- 响应样例
STATUS CODE 200
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
{ "status": "SUCCESS", "entities": { "image_id": "e9e91bff-14b6-4a0b-8377-4ed0813e3360", "image_name": "asdfasdfasdfas", "process_percent": 0.20, "current_task": "CreateImageByInstanceTask", "results": [{ "image_id": "49e9447f-7dff-41e0-8036-f66fe5488c8b", "project_id": "089b2f9a3d80d3062f24c00ca4ed5cbd", "status": "success" } ] }, "job_id": "ff8080814dbd65d7014dbe0d84db0013", "job_type": "createImageByInstance", "begin_time": "04-Jun-2015 18:11:06:586", "end_time": "", "error_code": null, "fail_reason": null }