解除挂起 - ResumePipeline
功能介绍
解除挂起
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipelineRunId}/jobs/{jobRunId}/steps/{stepRunId}/resume
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
|
pipeline_id |
是 |
String |
参数解释: 流水线ID,可以通过查询流水线列表接口获取,其中pipelines.pipelineId即为流水线ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
|
pipelineRunId |
是 |
String |
参数解释: 流水线运行实例ID,运行流水线接口的返回值即为流水线运行实例ID。 约束限制: 不涉及。 取值范围: 32位字符,仅由数字和字母组成。 默认取值: 不涉及。 |
|
jobRunId |
是 |
String |
参数解释: 流水线任务ID。可通过获取流水线执行详情接口返回体stages字段中找出所有人工审核任务,其中JobRun.id即为job_run_id。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。 |
|
stepRunId |
是 |
String |
参数解释: 流水线步骤ID。可以通过查询流水线详情接口,其中stages.jobs.steps中的id即为stepRunId 约束限制: 不涉及。 取值范围: 32位字符。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
success |
Boolean |
参数解释: 操作是否成功。 取值范围:
|
请求示例
POST https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/dc73b5ed58a64ab7a469b9480e5f6632/pipeline-runs/b72018a78183443b85a754f5f8dcab82/jobs/dff98cdf546a419e86d44563e652f09f/steps/91c3ede034af44f2a613531a32e87200/resume
响应示例
状态码:200
响应体
{
"success" : true
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
响应体 |
错误码
请参见错误码。