文档

StartPipelineRun - 运行流水线

更新时间:

可以运行流水线。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /organizations/{organizationId}/pipelines/{pipelineId}/run

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
pipelineIdlong

流水线 ID,可在流水线链接中获取,如 https://flow.aliyun.com/pipelines/【PipelineId】/current 5ebbc0228123212b59xxxxx

123
paramsstring

流水线运行参数 分支模式运行分支
envs 运行变量 runningBranchs 运行分支 key 为仓库地址 runningTags 运行 tag key 为仓库地址 runningPipelineArtifacts key 为 flow 类型的制品源地址 runningAcrArtifacts key 为 acr 类型的制品源地址 runningPackagesArtifacts key 为 package 类型的制品源地址 comment 运行备注

{ "branchModeBranchs": ["branch1", "branch2"], "envs": { "k1": "v1", "k2": "v2", "k3": "v3" }, "runningBranchs": { "https://codeup.aliyun.com/60c1abb32c5969c370c5fcd0/Codeup-Demo.git": "master1" }, "runningTags": { "https://codeup.aliyun.com/60c1abb32c5969c370c5fcd0/Codeup-Demo.git": "1.0" }, "runningPipelineArtifacts": { "3184679": "12" }, "runningAcrArtifacts": { "yunxiao-registry.cn-beijing.cr.aliyuncs.com/build-steps/tool-registry": "89b20155-2024-05-14-21-52-44" }, "runningPackagesArtifacts": { "generic/flow_generic_repo/Artifacts_3183732": "2024-06-04-17-58-34" }, "comment":"222" }

返回参数

名称类型描述示例值
object
requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMessagestring

错误信息

""
pipelineRunIdlong

流水线运行实例 id

1
successboolean

true 接口调用成功,false 接口调用失败

true
errorCodestring

错误码

""

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMessage": "\"\"",
  "pipelineRunId": 1,
  "success": true,
  "errorCode": "\"\""
}

错误码

HTTP status code错误码错误信息描述
400InvalidParam.ParamNotPresentThe parameter is invalid.参数有误,请检查参数
400InvalidUser.NotFoundThe user that is invoking the API service is not a registered user.调用 API 的用户,未注册为云效用户
403Forbidden.UserNotInCurrentOrganizationThe user is not in the organization and is not authorized to perform the operation.当前用户不在该企业中,无权进行操作。
404InvalidOrganization.NotFoundThe organization is not found.企业不存在,请检查企业ID是否正确
404InvalidPipeline.NotFoundThe pipeline is not found.流水线不存在
404InvalidPipelineRun.NotFoundThe pipeline execution instance is not found.流水线运行实例不存在

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史