Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Canceling a Pipeline Queuing
Updated on 2025-03-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Canceling a Pipeline Queuing

Function

This API is used to cancel a pipeline queuing.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/{pipelineRunId}/cancel-queuing/{id}

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.

id

Yes

String

Pipeline queuing 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

pipeline_run_id

String

Parameter description:

Pipeline run ID.

Value range:

32 characters, including only digits and letters.

Example Requests

POST https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipelines/c173d99dbbb54626b64cf5694c0a4e8e/071112d87d3e4ed49130c691936202e9/cancel-queuing/1

{ }

Example Responses

Status code: 200

Response body.

{
  "pipeline_run_id" : "8173263bf6c743f4b13f65bbf62dbf2c"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.

Parent Topic: Pipeline Management