Resuming a Pipeline

Function

This API is used to resume a pipeline.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipelineRunId}/jobs/{jobRunId}/steps/{stepRunId}/resume

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
pipeline_id	Yes	String	Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
pipelineRunId	Yes	String	Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID.
jobRunId	Yes	String	Pipeline job ID.
stepRunId	Yes	String	Pipeline step ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
success	Boolean	Definition: Whether the operation is successful. Value range: true: The operation is successful. false: The operation fails.

Example Requests

POST https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/dc73b5ed58a64ab7a469b9480e5f6632/pipeline-runs/b72018a78183443b85a754f5f8dcab82/jobs/dff98cdf546a419e86d44563e652f09f/steps/91c3ede034af44f2a613531a32e87200/resume