Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying the Batch Pipeline Execution Result

Updated on 2025-12-16 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Batch Pipeline Execution Result

Function

This API is used to query the batch pipeline execution result.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/batch-runs/result

**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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
query	Yes	Array of query objects	Definition: Request body. Constraints: N/A Value range: N/A Default value: N/A

**Table 3** query
Parameter	Mandatory	Type	Description
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 only 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 only digits and letters. Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	Array of result objects	Definition: Response body. Value range: N/A

**Table 5** result
Parameter	Type	Description
pipeline_id	String	Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Value range: The value consists of 32 characters, including only digits and letters.
pipeline_name	String	Definition: Pipeline name. Value range: N/A
pipeline_run_id	String	Definition: Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID. Value range: N/A
status	String	Definition: Pipeline status. Value range: N/A
reason	String	Definition: Cause of the pipeline startup failure. Value range: N/A

Example Requests

POST https://{endpoint}/v5/db8d07265e24426598b3eb03a7818972/api/pipelines/batch-runs/result

{
  "query" : [ {
    "pipeline_id" : "6ba9a2dbc7024c22a9a6614516dc22db",
    "pipeline_run_id" : "e41fe3981361476eb6dad17ad98c683c"
  } ]
}

Example Responses

Status code: 200

Response body.

{
  "result" : [ {
    "pipeline_id" : "6ba9a2dbc7024c22a9a6614516dc22db",
    "pipeline_name" : "Pipeline 1",
    "pipeline_run_id" : "e41fe3981361476eb6dad17ad98c683c",
    "status" : "START_FAILED",
    "reason" : "Current pipeline is banned."
  } ]
}