文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 部署任务管理/ 查询部署任务触发规则设置
更新时间:2025-09-30 GMT+08:00
分享

查询部署任务触发规则设置

功能介绍

根据部署任务ID查询任务触发规则设置。

调用方法

请参见如何调用API

URI

GET /v2/task/trigger/detail

表1 Query参数

参数

是否必选

参数类型

描述

task_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

trigger_source

String

参数解释

部署任务允许执行的场景。

取值范围

  • 0: 所有执行请求均可执行。

  • 1: 只允许流水线触发执行。

artifact_source_system

String

参数解释

当任务只允许流水线触发执行时,流水线传递的来源信息。

取值范围

Artifact: 来源信息为CodeArtsArtifact。

artifact_type

String

参数解释

当任务只允许流水线触发执行时,对应流水线源的制品仓库类型。

取值范围

  • generic: 软件发布库。

  • docker: Docker库。

请求示例

根据部署任务ID查询任务触发规则设置。

https://{endpoint}/v2/task/trigger/detail?task_id=f21d58b563e04d6c8a79d015fadeb73

响应示例

状态码:200

OK,表示查询部署任务触发规则设置成功。

{
  "trigger_source" : 1,
  "artifact_source_system" : "Artifact",
  "artifact_type" : "generic"
}

状态码

状态码

描述

200

OK,表示查询部署任务触发规则设置成功。

错误码

请参见错误码

相关文档