接口功能介绍
执行流水线
接口约束
无
URI
POST /v1/pipelines/runPipeline
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID,请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
branchName | 否 | String | 分支名称,流水线类型为源码必填 | ||
pipelineOrderId | 是 | String | 流水线ID,数据来源于分页查询流水线列表,若无数据,请在edas控制台,选择自己所需的项目下,在持续交付->流水线下新增自己所需的流水线能力 | ||
variableList | 否 | Array of Objects | 变量列表 | variableList | |
packageVer | 否 | String | 制品版本,流水线类型为制品必填 | 1.0 | |
imageVer | 否 | String | 镜像版本,流水线类型为镜像必填 | 1.0 |
表 variableList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 变量名称 | ||
type | 是 | String | 变量类型 | ||
value | 是 | String | 变量值 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应编码 | 2000 | |
message | String | 消息内容 | ||
returnObj | Object | 返回对象 | returnObj | |
error | String | 调用错误时返回的错误编码 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
uuid | String | 流水线执行ID |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"branchName":"master",
"pipelineOrderId":" c3a2e481-93a4-4c83-b908-687ee39a0f53 ",
"variableList":{
"name":"test",
"type":"COMMON_ENV_VAR",
"value":"test"
}
}
响应示例
{"statusCode": "2000","returnObj": {"uuid ":" 642b96e7-77d1-43ab-8e65-82eec877f396 ","message": "成功"}
状态码
请参考 状态码
错误码
请参考 错误码