Updated on 2026-01-12 GMT+08:00

Stopping a Pipeline

Function

This API is used to stop a pipeline.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/stop

**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
pipeline_run_id	Yes	String	Definition: Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** 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/93d8e0553c20411fba06bb112b5b59af/api/pipelines/794514e0a3184e5db0a4740112deee0f/pipeline-runs/de6c9098f45a4ac58a6efc9c1b81df82/stop

Example Responses

Status code: 200

{
  "success" : true
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes

See Error Codes.

Parent topic: Pipeline Management