失败放行 - ManualReleasePipeline
功能介绍
失败放行,用于流水线中任务执行失败后手动放行,使流水线继续执行。
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/jobs/{job_run_id}/manual-release
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
| pipeline_id | 是 | String | 参数解释: 流水线ID,可以通过查询流水线列表接口获取,其中pipelines.pipelineId即为流水线ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
| pipeline_run_id | 是 | String | 参数解释: 流水线运行实例ID,启动流水线接口的返回值即为流水线运行实例ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
| job_run_id | 是 | String | 参数解释: job运行id。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| message | 否 | String | 放行说明 |
响应参数
状态码:200
请求示例
POST https://{endpoint}/v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/jobs/{job_run_id}/manual-release
{
"message" : "manual release"
} 响应示例
状态码:200
{
"success" : true
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 响应体 |
错误码
请参见错误码。