更新时间:2025-11-17 GMT+08:00
分享

获取部署任务状态

功能介绍

根据部署任务ID获取部署任务执行状态。

调用方法

请参见如何调用API

URI

GET /v2/tasks/{task_id}/state

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释

部署任务ID。通过调用获取应用详情接口获取(响应体result.arrange_infos[0].id的值)。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

record_id

String

参数解释

部署记录ID。通过调用根据开始时间和结束时间查询项目下指定应用的历史部署记录列表接口获取(响应体result[0].execution_id的值)。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

step_state

Boolean

参数解释

是否返回各步骤的状态。

约束限制

不涉及。

取值范围

  • true:返回。

  • false:不返回。

默认取值

true。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

StateInfo object

参数解释

任务执行状态。

status

String

参数解释

查询任务执行状态结果。

取值范围

  • success: 查询任务执行状态成功。

  • error: 查询任务执行状态失败。

表5 StateInfo

参数

参数类型

描述

status

String

参数解释

部署任务执行状态。

取值范围

  • running:运行中。

  • succeeded:成功。

  • failed:失败。

nick_name

String

参数解释

应用创建者昵称。

取值范围

长度最长为128个字符。

record_id

String

参数解释

部署任务执行记录ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

task_id

String

参数解释

部署任务ID。

取值范围

由英文字母、数字组成,且长度为32个字符。

step

String

参数解释

部署任务各子步骤执行状态。

取值范围

  • running:运行中。

  • finish: 执行完。

start_time

String

参数解释

任务开始执行时间。时间格式:yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

end_time

String

参数解释

任务执行结束时间。时间格式:yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

executor

String

参数解释

部署者昵称。

取值范围

不涉及。

task_name

String

参数解释

应用名称。

取值范围

由中文字符、英文字母、数字及“_”、“-”组成,且长度为[3-128]个字符。

step_state

Array of StepInfo objects

参数解释

子步骤执行状态列表。

表6 StepInfo

参数

参数类型

描述

region

String

参数解释

局点信息。

取值范围

长度为[1,256]个字符。

enable

Boolean

参数解释

步骤是否开启。

取值范围

  • true: 步骤已启用。

  • false: 步骤未启用。

name

String

参数解释

步骤名称。

取值范围

不涉及。

elapsed_time

Long

参数解释

步骤执行时长,单位是毫秒。

取值范围

不涉及。

请求示例

根据部署任务ID获取部署任务执行状态。

https://{endpoint}/v2/tasks/e700f15965694253940502911220d76b/state?record_id=2c82ffe8d00d4968a4e5f7a36d87ae17&step_state=false

响应示例

状态码:200

OK,表示查询任务执行状态成功。

{
  "status" : "success",
  "result" : {
    "record_id" : "2c82ffe8d00d4968a4e5f7a36d87ae17",
    "task_id" : "e700f15965694253940502911220d76b",
    "nick_name" : "AB边账号",
    "status" : "succeeded",
    "step" : "finish",
    "start_time" : "2025-07-09 11:36:28",
    "end_time" : "2025-07-09 11:36:43",
    "executor" : "devcloud_test",
    "task_name" : "test"
  }
}

状态码

状态码

描述

200

OK,表示查询任务执行状态成功。

错误码

请参见错误码

相关文档