Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Executing Pipelines in Batches
Updated on 2025-03-25 GMT+08:00

Executing Pipelines in Batches

Function

This API is used to execute pipelines in batches.

Calling Method

For details, see Calling APIs.

URI

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

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.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

pipeline_ids

Yes

Array of strings

Pipeline ID list.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

Array of result objects

Response body.

Table 4 result

Parameter

Type

Description

pipeline_id

String

Pipeline ID.

pipeline_run_id

String

Pipeline run ID.

Example Requests

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

{
  "pipeline_ids" : [ "85f622d9d0ad4852a9451dbc9fe3156a", "0747d5a7099e45f69dc1d099945909a9" ]
}

Example Responses

Status code: 200

Response body.

{
  "result" : [ {
    "pipeline_id" : "85f622d9d0ad4852a9451dbc9fe3156a",
    "pipeline_run_id" : "e1a1c7e76c7040159650fb18a0c6c763"
  }, {
    "pipeline_id" : "0747d5a7099e45f69dc1d099945909a9",
    "pipeline_run_id" : "a50a604cbd4242888d00bef7ec7b1a8e"
  } ]
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.