Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying the Pipeline Execution Plan List

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

Online Debugging

CLI Examples

View PDF

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.
page_size	Integer	Page size.
page_index	Integer	Page number.
data	Array of data objects	Data list.

**Table 4** data
Parameter	Type	Description
id	String	id
name	String	Name.
pipeline_id	String	Pipeline ID.
creator_id	String	Creator ID.
creator	String	Creator name.
create_time	String	Creation time.
updater_id	String	Updater ID.
update_time	String	Update time.
run_param	String	Runtime parameter.

Example Requests

None

Example Responses

Status code: 200

{
  "total" : 1,
  "data" : [ {
    "id" : "3d5e9ce29c0c426096b79599e794d049",
    "name" : "test",
    "pipeline_id" : "4a5350af4b5041d4a7fdea16d6938eb0",
    "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
    "creator" : "user1",
    "create_time" : 1757923968000,
    "updater_id" : "05d8ca972f114765a8984795a8aa4d41",
    "update_time" : 1757923968000,
    "run_param" : "{}"
  } ],
  "page_size" : 10,
  "page_index" : 1
}