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

Updated on 2025-09-08 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	Request body.

**Table 3** query
Parameter	Mandatory	Type	Description
pipeline_id	Yes	String	Pipeline ID.
pipeline_run_id	Yes	String	Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	Array of result objects	Response body.

**Table 5** result
Parameter	Type	Description
pipeline_id	String	Pipeline ID.
pipeline_name	String	Pipeline name.
pipeline_run_id	String	Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID.
status	String	Pipeline startup status.
reason	String	Cause of the pipeline startup failure.

Example Requests

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

{
  "query" : [ {
    "pipeline_id" : "6ba9a2dbc7024c22a9a6614516dc22db",
    "pipeline_run_id" : "e41fe3981361476eb6dad17ad98c683c"
  }, {
    "pipeline_id" : "d7013d2402ff4cc88489ee5af324e049",
    "pipeline_run_id" : "3d8143d197dd4fa5b23f20ee39179af3"
  }, {
    "pipeline_id" : "2eb1fc4d750546b3bbc2566a7cf34d5b",
    "pipeline_run_id" : "ba15657cb88d46deb9e17f203a061f21"
  }, {
    "pipeline_id" : "cce81e5f7e604b609172aafcae73c025",
    "pipeline_run_id" : "73861d5a72e6417a81abb1baba1a8d16"
  }, {
    "pipeline_id" : "1d5107b3cd4746a3a03efef83b9e4e45",
    "pipeline_run_id" : "f68aa7ca562f4f31bfbb63628de0e2cd"
  }, {
    "pipeline_id" : "70aa57009b0d433587b58faf05e4fd7f",
    "pipeline_run_id" : "cd96020f0e2748048a6b4d1a15091c9b"
  } ]
}

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."
  }, {
    "pipeline_id" : "d7013d2402ff4cc88489ee5af324e049",
    "pipeline_name" : "Pipeline 2",
    "pipeline_run_id" : "3d8143d197dd4fa5b23f20ee39179af3",
    "status" : "START_SUCCESS",
    "reason" : null
  }, {
    "pipeline_id" : "2eb1fc4d750546b3bbc2566a7cf34d5b",
    "pipeline_name" : "Pipeline 3",
    "pipeline_run_id" : "ba15657cb88d46deb9e17f203a061f21",
    "status" : "START_SUCCESS",
    "reason" : null
  }, {
    "pipeline_id" : "cce81e5f7e604b609172aafcae73c025",
    "pipeline_name" : "Pipeline 4",
    "pipeline_run_id" : "73861d5a72e6417a81abb1baba1a8d16",
    "status" : "START_FAILED",
    "reason" : "Reached the maximum of 1 concurrencies for single pipeline. Entering the queuing state."
  }, {
    "pipeline_id" : "1d5107b3cd4746a3a03efef83b9e4e45",
    "pipeline_name" : "Pipeline 5",
    "pipeline_run_id" : "f68aa7ca562f4f31bfbb63628de0e2cd",
    "status" : "START_FAILED",
    "reason" : "The change request pipeline can not batch run."
  }, {
    "pipeline_id" : "70aa57009b0d433587b58faf05e4fd7f",
    "pipeline_name" : "Pipeline 6",
    "pipeline_run_id" : "cd96020f0e2748048a6b4d1a15091c9b",
    "status" : "START_SUCCESS",
    "reason" : null
  } ]
}