
# 获取任务详情 - ShowJob
#### 功能介绍
获取任务详情。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CAE/doc?api=ShowJob)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cae/cae_06_0016.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
#### URI
GET /v1/{project_id}/cae/jobs/{job_id}
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID，获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-cae/cae_06_0021.html)。 |
| job_id     | 是    | String | 任务ID。                                                                             |
#### 请求参数
表2请求Header参数 
| 参数                      | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| X-Auth-Token            | 是    | String | 用户Token。 - 获取Token，请参考《[统一身份认证服务API参考](https://support.huaweicloud.com/api-iam/iam_30_0001.html)》的"获取用户Token"章节。 - 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。                                                               |
| X-Enterprise-Project-ID | 否    | String | 企业项目ID。 - 创建环境时，环境会绑定企业项目ID。 - 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。 - 该字段不传（或传为字符串"0"）时，则查询默认企业项目下的资源。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《[企业管理服务用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)》。 |
| X-Environment-ID        | 是    | String | 环境ID。 - 获取环境ID，通过[获取环境列表](https://support.huaweicloud.com/api-cae/ListEnvironments.html)来获取环境信息。 - 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。                                                                            |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数          | 参数类型                                         | 描述                     |
|:---|:---|:---|
| api_version | String                                       | API版本，固定值"v1"，该值不可修改。  |
| kind        | String                                       | API类型，固定值"Job"，该值不可修改。 |
| spec        | [JobSpec] object | job规格信息。               |
   
 表4JobSpec 
| 参数       | 参数类型                                             | 描述                                                                                                                                     |
|:---|:---|:---|
| progress | Number                                           | 任务进度。                                                                                                                                  |
| status   | String                                           | 任务状态。 - init: 初始化中 - running: 运行中 - failed: 执行失败 - timeout: 执行超时 - success: 执行成功 - skip: 忽略执行 - terminating: 手动终止中 - terminated: 已手动终止 |
| tasks    | Array of [Task] objects | 子任务。                                                                                                                                   |
   
 表5Task 
| 参数         | 参数类型    | 描述                                                                                                                                                                        |
|:---|:---|:---|
| index      | Integer | 任务序号。                                                                                                                                                                     |
| name       | String  | 任务名称。                                                                                                                                                                     |
| status     | String  | **参数解释：** 任务状态。 **取值范围：** - init: 初始化中 - running: 运行中 - failed: 执行失败 - timeout: 执行超时 - success: 执行成功 - skip: 忽略执行 - terminating: 手动终止中 - terminated: 已手动终止 **默认取值：** 不涉及。 |
| detail     | String  | 任务详情。                                                                                                                                                                     |
| created_at | String  | 创建时间。                                                                                                                                                                     |
| updated_at | String  | 更新时间。                                                                                                                                                                     |
   
#### 请求示例
获取任务详情。
```
GET https://{endpoint}/v1/{project_id}/cae/jobs/{job_id}
```
#### 响应示例
**状态码：200**
请求成功。
```
{
  "api_version" : "v1",
  "kind" : "Job",
  "spec" : {
    "progress" : 0,
    "status" : "running",
    "tasks" : [ {
      "index" : 1,
      "name" : "upgrade",
      "status" : "init",
      "detail" : "",
      "created_at" : "2023-02-16T11:24:07.950175Z",
      "updated_at" : "2023-02-16T11:24:07.950175Z"
    } ]
  }
}
```
#### 状态码
| 状态码 | 描述    |
|:---|:---|
| 200 | 请求成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-cae/ErrorCode.html)。
