更新时间:2025-10-24 GMT+08:00
分享

更新yaml流水线详情

功能介绍

更新yaml流水线详情,可以先通过查询流水线详情接口获取流水线详情,再更新需要的字段。

调用方法

请参见如何调用API

URI

PUT /v6/{domain_id}/api/pac/pipelines/{pipeline_id}

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

租户ID,可以在Console控制台的API凭证处获取,账号ID就是租户ID。

约束限制

不涉及

取值范围

32位字符。

默认取值

不涉及。

pipeline_id

String

参数解释

流水线ID,可以通过查询流水线列表接口,其中pipelines.pipelineId即为流水线ID。

约束限制

不涉及。

取值范围

32位字符,仅由数字和字母组成。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

CodeArts项目的32位UUID,项目唯一标识,通过查询项目列表接口查询项目列表获取。

约束限制

不涉及。

取值范围

32位字符。

默认取值

不涉及。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

流水线名称。

约束限制

租户下流水线名称不可重复。

取值范围

仅包含中文、大小写英文字母、数字、'-'和'_',且长度为[1,128]个字符。

默认取值

不涉及。

description

String

参数解释

流水线描述信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

push_to_repo

Boolean

参数解释

是否推送到代码仓。

约束限制

不涉及。

取值范围

  • true:推送到代码仓。

  • false:不推送到代码仓。

默认取值

false。

new_branch

Boolean

参数解释

是否使用新分支。

约束限制

不涉及。

取值范围

  • true:使用新分支。

  • false:不使用新分支。

默认取值

true。

new_file

Boolean

参数解释

是否创建新文件。

约束限制

不涉及。

取值范围

  • true:创建新文件。

  • false:不创建新文件。

默认取值

true。

file_content

String

参数解释

文件内容详情。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

selected_branch

String

参数解释

所选分支。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

push_branch

String

参数解释

推送的分支名。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

commit_message

String

参数解释

提交备注信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

create_pull_request

Boolean

参数解释

是否创建拉取请求。

约束限制

不涉及。

取值范围

  • true:创建拉取请求。

  • false:不创建拉取请求。

默认取值

true。

agency_name

String

参数解释

委托URN,流水线基本信息处配置,可从CodeArts控制台统一身份认证获取。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

pipeline_id

String

参数解释

流水线ID,可以通过查询流水线列表接口,其中pipelines.pipelineId即为流水线ID。

约束限制

不涉及。

取值范围

32位字符,仅由数字和字母组成。

默认取值

不涉及。

请求示例

PUT https://{endpoint}/v6/93b9fc6ffc6a4edc9ab049c1f0dbec4b/api/pac/pipelines/f2286112591548af960ba8e80a92e0a1

{
  "name" : "新建流水线-20240830100147",
  "description" : "",
  "push_to_repo" : false,
  "new_branch" : false,
  "selected_branch" : "master",
  "new_file" : false,
  "file_content" : "content",
  "create_pull_request" : false,
  "push_branch" : "",
  "commit_message" : "",
  "agency_name" : null
}

响应示例

状态码:200

OK

{
  "pipeline_id" : "f2286112591548af960ba8e80a92e0a1"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档