文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 部署任务/ 获取部署任务详细信息
更新时间：2024-09-14 GMT+08:00
查看PDF
分享

获取部署任务详细信息

功能介绍

通过此API获取部署任务详细信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/cas/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。

job_id

是

String

部署任务ID，为应用中创建组件、根据组件ID修改组件信息、根据组件ID下发组件任务接口响应参数的job_id。
表2 查询参数

参数

是否必选

参数类型

描述

limit

否

Integer

指定个数。

offset

否

Integer

指定偏移量。

desc

否

String

是否降序：

true=desc，false=asc。

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。

响应消息

表4 响应参数

参数

参数类型

描述

task_count

Integer

部署任务数量。

job

Object

构建工程参数，请参考表5。

tasks

Array<Object>

部署任务参数，请参考表6。
表5 job

参数

参数类型

描述

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：未知任务。

ORDER_ID

String

排序ID。

PROJECT_ID

String

创建租户Project ID。

SERVICE_INSTANCE_ID

String

实例ID。
表6 task

参数

参数类型

描述

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

内部错误

错误码

错误码格式为：SVCSTG.00100.[Error_ID]，例如：SVCSTG.00100400。错误码说明请参考ServiceStage错误码。

父主题： 部署任务

相关文档