Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying the Pipeline Execution Plan List
Updated on 2025-09-08 GMT+08:00

Querying the Pipeline Execution Plan List

Function

This API is used to query the pipeline execution plan list.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipelineId}/execution-plan/list

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

pipelineId

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Execution plan name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

page_index

No

String

Definition:

Page number that is queried.

Constraints:

N/A

Value range:

≥ 0

Default value:

N/A

page_size

No

String

Definition:

Number of records of each query.

Constraints:

N/A

Value range:

≥ 0

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number.

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

pageSize

Integer

Page size.

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

pageIndex

Integer

Page number.

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

data

Array

param6

Table 7 data

Parameter

Type

Description

id

String

id

name

String

Name.

pipelineId

String

Pipeline ID.

creatorId

String

Creator ID.

creator

String

Creator name.

createTime

String

Creation time.

updaterId

String

Updater ID.

updateTime

String

Update time.

runParam

String

Runtime parameters.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Total number.

200

Page size.

200

Page number.

200

Data list.

Error Codes

See Error Codes.