Updated on 2025-03-25 GMT+08:00

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

Parameter description:

CodeArts project ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipeline_id

Yes

String

Parameter description:

Pipeline ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipelineRunId

Yes

String

Pipeline run ID.

jobRunId

Yes

String

Pipeline job ID.

stepRunId

Yes

String

Pipeline step ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

body

Yes

Object

Request body.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success

Boolean

Parameter description:

Whether the operation is successful.

Value range:

None.

Example Requests

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

{ }

Example Responses

Status code: 200

Response body.

{
  "success" : true
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.