查询租户的镜像任务列表 - ListImageJobs

功能介绍

该接口用于查询租户的异步任务执行情况。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:images:listImageJobs
List
-
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:images:listImageJobs	List	-	-	-	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目唯一标识。

表2 Query参数
参数	是否必选	参数类型	描述
status	否	String	job状态： WAITING - 等待 RUNNING - 运行中 SUCCESS - 完成 FAILED - 失败
job_type	是	String	job类型： CREATE_SERVER - 创建镜像实例 CREATE_SERVER_IMAGE - 构建镜像 DELETE_SERVER - 删除镜像实例
offset	否	Integer	查询的偏移量，默认值0。
limit	否	Integer	查询的数量，值区间[1-100]，默认值10。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
count	Integer	总数。
items	Array of ImageJobInfo objects	任务信息列表，返回列表条目数量上限为分页的最大上限值。

表5 ImageJobInfo
参数	参数类型	描述
id	String	任务ID。
job_type	String	任务类型。
begin_time	String	任务创建时间。
end_time	String	任务结束时间。
status	String	job状态。 WAITING - 等待 RUNNING - 运行中 `SUCCESS - 完成 FAILED - 失败
sub_jobs_total	Integer	子任务总数。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：405

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

状态码：503

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，失败时返回。
error_msg	String	错误描述。

请求示例

无

响应示例

状态码：200

成功响应。

{
  "count" : 0,
  "items" : [ {
    "id" : "1",
    "job_type" : "createServer",
    "begin_time" : "2022-03-07T10:40:43.858Z",
    "end_time" : "2022-03-07T10:40:43.858Z",
    "status" : "WAITING",
    "sub_jobs_total" : 10
  } ]
}

状态码

状态码	描述
200	成功响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。