文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 查询Job状态/ 查询镜像任务详情
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

查询镜像任务详情

功能介绍

该接口用于查询异步任务的执行情况，比如查询创建镜像实例任务的执行状态。

调试

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

URI

GET /v1/{project_id}/image-server-jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

job_id

是

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

任务ID。

job_type

String

任务类型。

begin_time

String

任务创建时间。

end_time

String

任务结束时间。

status

String

任务状态。

sub_jobs_total

Integer

子任务总数。

sub_jobs

Array of ImageJobDetailInfo objects

子任务列表
表4 ImageJobDetailInfo

参数

参数类型

描述

id

String

子任务ID。

job_type

String

job类型

  • CREATE_SERVER - 创建镜像实例

  • CREATE_SERVER_IMAGE - 构建镜像

  • DELETE_SERVER - 删除镜像实例

job_resource_info

ImageJobResourceInfo object

任务结果对应的资源信息，根据任务类型区分：

  • 镜像实例 - 镜像实例信息

  • 镜像 - 镜像信息

begin_time

String

任务创建时间。

end_time

String

任务结束时间。

status

String

任务状态。

job_execute_info

ImageJobExecuteInfo object

任务执行失败信息

project_id

String

项目ID。

job_id

String

任务ID。
表5 ImageJobResourceInfo

参数

参数类型

描述

resource_id

String

资源ID

resource_name

String

产物名称，或者被操作资源名称
表6 ImageJobExecuteInfo

参数

参数类型

描述

error_code

String

任务执行失败时的错误码。

error_message

String

任务失败原因。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 405

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 503

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

GET v1/a4da8115c9d8464ead3a38309130523f/image-server-jobs/702364883651395584

响应示例

状态码： 200

成功响应。

{
  "id" : "702364883651395584",
  "job_type" : "CREATE_SERVER_IMAGE",
  "begin_time" : "2024-05-20T10:39:49.61Z",
  "end_time" : "2024-05-20T11:03:24.206Z",
  "status" : "SUCCESS",
  "sub_jobs_total" : 1,
  "sub_jobs" : [ {
    "id" : "702364884037271552",
    "job_type" : "CREATE_SERVER_IMAGE",
    "job_resource_info" : {
      "resource_id" : "f5d443de-a623-4950-a74d-569fe63c1f7a",
      "resource_name" : "123"
    },
    "begin_time" : "2024-05-20T10:39:50.723Z",
    "end_time" : "2024-05-20T11:03:24.194Z",
    "status" : "SUCCESS",
    "job_execute_info" : {
      "error_code" : "",
      "error_message" : ""
    },
    "project_id" : "a4da8115c9d8464ead3a38309130523f",
    "job_id" : "702364883651395584"
  } ]
}

状态码

状态码

描述

200

成功响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 查询Job状态

相关文档