可以终止流水线任务运行。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
PUT /organization/{organizationId}/pipelines/{pipelineId}/pipelineRuns/{pipelineRunId}/jobs/{jobId}/stop
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| organizationId | string | 是 | 企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https:// devops.aliyun.com/organization/【OrgId】 | 5ebbc0228123212b59xxxxx |
| pipelineId | long | 是 | 流水线 ID，可在流水线链接中获取，如 https:// flow.aliyun.com/pipelines/【PipelineId】/current | 123 |
| pipelineRunId | long | 是 | 流水线运行实例 id | 3 |
| jobId | long | 是 | 流水线运行任务 Id，可通过 API https://help.aliyun.com/document_detail/460565.html 获取任务 Id | 2324334 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
"errorMessage": "\"'",
"errorCode": "\"\"",
"success": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParam.ParamNotPresent | The parameter is invalid. | 参数有误，请检查参数 |
| 400 | InvalidUser.NotFound | The user that is invoking the API service is not a registered user. | 调用 API 的用户，未注册为云效用户 |
| 403 | Forbidden.UserNotInCurrentOrganization | The user is not in the organization and is not authorized to perform the operation. | 当前用户不在该企业中，无权进行操作。 |
| 404 | InvalidOrganization.NotFound | The organization is not found. | 企业不存在，请检查企业ID是否正确 |
| 404 | InvalidPipeline.NotFound | The pipeline is not found. | 流水线不存在 |
| 404 | InvalidPipelineRun.NotFound | The pipeline execution instance is not found. | 流水线运行实例不存在 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史