文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 使用yaml运行代码化流水线
更新时间:2025-09-08 GMT+08:00

使用yaml运行代码化流水线

功能介绍

使用yaml直接运行(DryRun)代码化流水线

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/api/pac/pipelines/dry-run

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

语言类型。

约束限制

不涉及。

取值范围

  • zh-cn:中文。

  • en-us:英文。

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

repository

Repository object

参数解释

代码仓信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

流水线运行描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

configuration

String

参数解释

yaml内容。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 Repository

参数

是否必选

参数类型

描述

type

String

参数解释

代码仓类型。

约束限制

不涉及。

取值范围

  • codehub。

  • gitee。

  • github。

  • gitcode。

  • gitlab。

默认取值

不涉及。

git_http_url

String

参数解释

代码仓HTTPS地址。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

branch

String

参数解释

代码仓分支。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

pipeline_id

String

由DryRun临时创建的流水线的ID

pipeline_run_id

String

流水线运行实例ID

请求示例

POST https://{endpoint}/v5/6428c2e2b4b64affa14ec80896695c49/api/pac/pipelines/dry-run

响应示例

状态码

状态码

描述

200

DryRun代码化流水线返回体

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码