
# 查询任务详情 - ShowJob
#### 功能介绍
该接口用于查询异步任务的执行情况，比如查询创建桌面任务的执行状态。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ShowJob)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:jobs:get | Read | -           | -   | -  | -      |
     
  
 
#### URI
GET /v2/{project_id}/workspace-jobs/{job_id}
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目id。 |
| job_id     | 是    | String | 任务ID。 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表2响应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 | 子任务列表。  |
   
 表3JobDetailInfo 
| 参数          | 参数类型                                                   | 描述           |
|:---|:---|:---|
| 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地址。        |
   
 表4JobEntities 
| 参数           | 参数类型   | 描述    |
|:---|:---|:---|
| desktop_id   | String | 桌面ID。 |
| product_id   | String | 套餐ID。 |
| user_name    | String | 用户名。  |
| desktop_name | String | 桌面名称。 |
| ip_address   | String | ip地址。 |
   
**状态码：404**
表5响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：default**
表6响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
#### 请求示例
```
GET /v2/ac234de25c6741d2b1273da49eea1b9e/workspace-jobs/2382dd96-xxxxx56d-axxxc4b09a35b58
```
#### 响应示例
**状态码：200**
查询任务详情响应。
```
{
  "id" : "3eeb93ab-3bd0-431e-8260-94733f216785",
  "job_type" : "createDesktops",
  "begin_time" : "2025-04-28T09:53:55Z",
  "end_time" : "2025-04-28T10:01:46Z",
  "status" : "COMPLETE",
  "sub_jobs_total" : 1,
  "sub_jobs" : [ {
    "id" : "362767c6-691c-473d-b533-af80af26a00a",
    "job_type" : "createDesktops",
    "entities" : {
      "desktop_id" : "cf0a55ac-ca64-4e20-999c-ce9b68a80f61",
      "product_id" : "workspace.x86.ultimate.xlarge2",
      "user_name" : "LOCAL\\dsa",
      "ip_address" : "10.1.0.169"
    },
    "begin_time" : "2025-04-28T09:54:27Z",
    "end_time" : "2025-04-28T10:01:45Z",
    "status" : "SUCCESS",
    "error_code" : "",
    "fail_reason" : "",
    "job_id" : "3eeb93ab-3bd0-431e-8260-94733f216785",
    "process" : 100
  } ]
}
```
#### 状态码
| 状态码     | 描述        |
|:---|:---|
| 200     | 查询任务详情响应。 |
| 404     | 找不到资源。    |
| default | 默认失败响应。   |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。
