UpdatePipelineRun - 终止流水线运行

通过 OpenAPI 终止流水线运行。

适用版本

企业标准版

服务接入点与授权信息

请求语法

PUT https://{domain}/oapi/v1/flow/organizations/{organizationId}/pipelines/{pipelineId}/runs/{pipelineRunId}

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

企业 Id。

5ebbc0228123212b59xxxxx

pipelineId

string

path

流水线 Id。

36**66

pipelineRunId

string

path

流水线运行实例 Id。

1

请求示例

curl -X 'PUT' \
  'https://test.rdc.aliyuncs.com/oapi/v1/flow/organizations/5ebbc0228123212b59xxxxx/pipelines/123/runs/1' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

boolean

是否成功。

true

返回示例

true

错误码

访问错误码中心查看 API 相关错误码。