触发流水线运行,返回流水线运行实例id

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ExecutePipeline

系统规定参数。取值:ExecutePipeline。

OrgId String 5ebbc0408123212b59dxxxxx

企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如

https://devops.aliyun.com/organization/【OrgId】

PipelineId Long 123345

流水线ID,可在流水线链接中获取,如

https://flow.aliyun.com/pipelines/【PipelineId】/current

Parameters String {"aaa":"sss"}

流水线运行参数,json格式 。

{"aaa":"sss","key":"value"},可以覆盖流水线中配置的全局参数

UserPk String 1241965038xxxxx

用户pk,非必填,只有调用接口使用的ak和用户pk不一致时,才需要

返回数据

名称 类型 示例值 描述
ErrorCode String ”“

错误码

ErrorMessage String ”“

错误信息

Object Long 50035670

返回的流水线运行实例id FlowInstanceId

RequestId String SADS32-SDSADS-ASDSAD-SADSADS

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

Success Boolean true

值true表示调用成功,false表示失败

示例

请求示例

http(s)://[Endpoint]/?Action=ExecutePipeline
&OrgId=5ebbc0408123212b59dxxxxx
&PipelineId=123345
&<公共请求参数>

正常返回示例

XML格式

<RequestId>SADS32-SDSADS-ASDSAD-SADSADS</RequestId>
<Object>50035670</Object>
<ErrorCode>”“</ErrorCode>
<ErrorMessage>”“</ErrorMessage>
<Success>true</Success>

JSON格式

{"RequestId":"SADS32-SDSADS-ASDSAD-SADSADS","Object":"50035670","ErrorCode":"”“","ErrorMessage":"”“","Success":"true"}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidOrganization.NotFound The specified organization doe not exist. 企业信息有误,未找到该企业
404 InvalidPipeline.NotFound The specified pipeline does not exist. 未找到流水线
404 InvalidUser.NotFound The specified user does not exist. 用户数据有误,未找到该用户
400 InvalidUser.UserNotInCurrentOrganization The user does not belong to the specified organization. 当前用户不属于该企业
500 SystemError.UnKnownError An error occurred while processing your request. 系统未知异常

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