终止一个流水线实例运行。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CancelPipeline | 系统规定参数。取值：CancelPipeline。 |
| FlowInstanceId | Long | 是 | 123 | 流水线运行实例ID，ExecutePieline 接口的返回值 |
| OrgId | String | 是 | 5ebbc0408123212b59xxxxx | 企业标识，也称企业ID，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrgId】 |
| PipelineId | Long | 是 | 123 | 流水线ID，可在流水线链接中获取，如 https://flow.aliyun.com/pipelines/【PipelineId】/current |
| UserPk | String | 否 | 5423445325543221xxx | 用户pk，非必填，只有调用接口使用的ak和用户pk不一致时，才需要 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ErrorCode | String | "" | 错误码 |
| ErrorMessage | String | "" | 错误信息 |
| Object | Boolean | true | true 终止成功 false 终止失败 |
| RequestId | String | XSAXS-XSAXSA-XSXSA-XSAXSXS | 请求id，每次请求都是唯一值，便于后续排查问题 |
| Success | Boolean | true | true 接口调用成功，false 接口调用失败 |
示例
请求示例
http(s)://[Endpoint]/?Action=CancelPipeline
&FlowInstanceId=123
&OrgId=5ebbc0408123212b59xxxxx
&PipelineId=123
&<公共请求参数>正常返回示例
XML格式
<RequestId>1234567</RequestId>
<Object>true</Object>
<ErrorCode>300</ErrorCode>
<ErrorMessage>""</ErrorMessage>
<Success>true</Success>JSON格式
{"RequestId":"1234567","Object":"true","ErrorCode":"300","ErrorMessage":"\"\"","Success":"true"}错误码
访问错误中心查看更多错误码。