# 获取部署任务详细信息 - ObtainJobDetails #### 功能介绍 此API用于获取部署任务详细信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ServiceStage/doc?api=ShowJobInfo&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | servicestage:app:listApplication | list | - | - | servicestage:app:list | - | #### URI GET /v3/{project_id}/cas/jobs/{job_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户项目ID。获取方法，请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | job_id | 是 | String | **参数解释：** 部署任务ID，为[应用中创建组件 - CreateApplicationComponent](https://support.huaweicloud.com/api-servicestage/servicestage_06_0076.html)、[应用中导入CCE工作负载创建组件 - ImportCCEWorkloadToAnApplicationToCreateComponent](https://support.huaweicloud.com/api-servicestage/servicestage_06_0167.html)、[根据组件ID修改组件信息 - ModifyComponentInformationBasedOnTheComponentID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0079.html)、[根据组件ID下发组件任务 - DeliverComponentTaskBasedOnTheComponentID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0082.html)接口响应参数的job_id。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2查询参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 指定个数。 | | offset | 否 | Integer | 指定偏移量。 | | desc | 否 | String | 是否降序： true=desc，false=asc。 | #### 请求消息 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及 **取值范围：** application/json;charset=utf8 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[认证鉴权](https://support.huaweicloud.com/api-servicestage/servicestage_06_0010.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应消息 表4响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_count | Integer | **参数解释：** 部署任务数量。 **取值范围：** 不涉及 | | job | Object | **参数解释：** 构建工程参数，请参考[表5]。 | | tasks | Array of objects | **参数解释：** 部署任务参数，请参考[表6]。 | 表5job | 参数 | 参数类型 | 描述 | |:---|:---|:---| | execution_status | String | **参数解释：** 执行状态。 **取值范围：** - SUBMITTED：已提交但尚未处理。 - SCHEDULED：计划在未来执行的。 - RUNNING：当前正在处理。 - FAILED：处于失败状态。 - SUCCEEDED：处于成功状态。 - CANCELLED：已取消。 - PARTIALLY_FAILED：部分失败。 - ROLLBACKING：正在回滚。 - ROLLBACKED：已回滚。 - UNKNOWN：未知状态。 | | job_id | String | **参数解释：** 工作ID。 **取值范围：** 不涉及 | | job_type | String | **参数解释：** 类别。 **取值范围：** - PROVISION：提供服务任务。 - DEPROVISION：取消提交服务任务。 - DAILY_OPERATION：日常操作任务。 - SYSTEM_INNER：系统内部任务。 - UNKNOWN：未知任务。 | 表6task | 参数 | 参数类型 | 描述 | |:---|:---|:---| | created_at | String | **参数解释：** 创建时间。 **取值范围：** 不涉及 | | messages | String | **参数解释：** 消息。 **取值范围：** 不涉及 | | task_id | String | **参数解释：** 任务ID。 **取值范围：** 不涉及 | | task_index | Integer | **参数解释：** 任务序号。 **取值范围：** 不涉及 | | task_name | String | **参数解释：** 任务名称。 **取值范围：** 不涉及 | | task_status | String | **参数解释：** 任务状态。 **取值范围：** - SUBMITTED：已提交但尚未处理。 - SCHEDULED：计划在未来执行的。 - RUNNING：当前正在处理。 - FAILED：处于失败状态。 - SUCCEEDED：处于成功状态。 - CANCELLED：已取消。 - PARTIALLY_FAILED：部分失败。 - SKIPPED：已跳过。 - ROLLBACKING：正在回滚。 - ROLLBACKED：已回滚。 - UNKNOWN：未知状态。 | | update_at | String | **参数解释：** 更新时间。 **取值范围：** 不涉及 | #### 请求示例 无 #### 响应示例 ``` { "job": { "execution_status": "SUCCEEDED", "job_id": "JOB17cb1778-07b1-4c8f-a183-c86cffbe8f9e", "job_type": "PROVISION" }, "tasks": [ { "task_id": "Task-af75dd60-0b04-4f4b-b669-0bad38fcdd97", "task_index": 4, "task_name": "VMAPP_CONTEXT_PREPARE_01", "task_status": "SUCCEEDED", "created_at": "2024-06-06T15:55:31.115Z", "update_at": "2024-06-06T15:55:31.136Z", "messages": "{}" }, { "task_id": "Task-50110d26-3973-49e1-95d3-d46755e865af", "task_index": 5, "task_name": "VMAPP_UPGRADE_002", "task_status": "SUCCEEDED", "created_at": "2024-06-06T15:55:31.136Z", "update_at": "2024-06-06T15:55:31.36Z", "messages": "{}" } ], "task_count": 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 错误的请求。 | | 404 | 请求对象不存在 | | 500 | 内部错误 | #### 错误码 请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。