文档首页/ 部署 CodeArts Deploy/ API参考/ API/ DeployState/ 获取部署任务状态
更新时间：2025-07-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取部署任务状态

功能介绍

获取部署任务状态

调用方法

请参见如何调用API。

URI

GET /v2/tasks/{task_id}/state

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

task_id
表2 Query参数

参数

是否必选

参数类型

描述

record_id

否

String

record_id

step_state

否

Boolean

是否返回部署任务各步骤的状态， true返回， false不返回

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

Content-Type

是

String

参数解释：

消息体的类型（格式）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

result

StateInfo object

任务基本信息

status

String

请求成功失败状态
表5 StateInfo

参数

参数类型

描述

status

String

任务执行状态

nick_name

String

用户昵称

record_id

String

执行记录id

task_id

String

任务id

step

String

步骤状态

start_time

String

开始时间

end_time

String

结束时间

executor

String

执行人

task_name

String

任务名称

step_state

Array of StepInfo objects

子步骤信息
表6 StepInfo

参数

参数类型

描述

region

String

请求的region

id

String

应用id

offset

String

偏移量

enable

String

是否启用

name

String

步骤名称

current_offset

String

当前偏移量

elapsed_time

String

任务执行时长

faq_url

String

常见问题

请求示例

无

响应示例

状态码：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

错误码

请参见错误码。

父主题： DeployState

相关文档