更新时间:2024-12-12 GMT+08:00

查询任务详情

功能介绍

该接口用于查询异步任务的执行情况,比如查询创建桌面任务的执行状态。

调试

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

URI

GET /v2/{project_id}/workspace-jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id。

job_id

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

Content-Type

String

发送的实体的MIME类型

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

任务ID

job_type

String

任务类型

begin_time

String

任务开始时间

end_time

String

任务结束时间

status

String

任务状态

job_error_code

String

任务错误码

fail_reason

String

任务失败原因

sub_jobs_total

Integer

子任务总数

sub_jobs

Array of JobDetailInfo objects

子任务列表

表4 JobDetailInfo

参数

参数类型

描述

id

String

子任务ID。

job_type

String

任务类型。

entities

JobEntities object

任务操作对象。

begin_time

String

任务创建时间。

end_time

String

任务结束时间。

status

String

任务状态。

error_code

String

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

fail_reason

String

任务失败原因。

host

String

任务执行的服务器IP。

project_id

String

项目ID。

job_id

String

任务ID。

process

Integer

任务进度。

attach_user

String

关联用户。

entity

String

操作对象。

ip_address

String

ip地址。

表5 JobEntities

参数

参数类型

描述

desktop_id

String

桌面ID。

product_id

String

套餐ID。

user_name

String

用户名。

desktop_name

String

桌面名称。

ip_address

String

ip地址。

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码: default

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/ac234de25c6741d2b1273da49eea1b9e/workspace-jobs/2382dd96-xxxxx56d-axxxc4b09a35b58

响应示例

状态码: 200

查询任务详情响应

{ }

状态码

状态码

描述

200

查询任务详情响应

404

找不到资源。

default

默认失败响应

错误码

请参见错误码