Obtaining the Pipeline List/Obtaining the Pipeline Execution Status of a Project

Function

URI

POST /v5/{project_id}/api/pipelines/list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
project_ids	No	Array of strings	Project IDs.
component_id	No	String	Component ID
name	No	String	Pipeline name. Fuzzy search is supported.
status	No	Array of strings	Status
is_publish	No	Boolean	Indicates whether the pipeline is a change pipeline.
creator_ids	No	Array of strings	Creator ID list.
executor_ids	No	Array of strings	Executor ID List
start_time	No	String	Start time
end_time	No	String	End Time
offset	No	Long	Specifies the initial offset.
limit	No	Long	Number of queried records.
sort_key	No	String	Sorting Field Name
sort_dir	No	String	Sorting rule
group_path_id	No	String	Pipeline Group ID
by_group	No	Boolean	Indicates whether to query by group.
query_new	No	Boolean	Indicates whether to query only the new pipeline.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
offset	Integer	Specifies the initial offset.
limit	Integer	Query Size
total	Integer	Total number.
pipelines	Array of pipelines objects	CloudPipeline homepage

**Table 5** pipelines
Parameter	Type	Description
pipeline_id	String	Pipeline ID
name	String	Pipeline name
project_id	String	Project ID
project_name	String	Project Name
component_id	String	Component ID
is_publish	Boolean	Indicates whether the pipeline is a change pipeline.
is_collect	Boolean	Do you want to add the pipeline to favorites?
manifest_version	String	Pipeline version.
create_time	Long	Created
latest_run	latest_run object	Latest Running Information
convert_sign	Integer	Old Version to New Version Flag

**Table 6** latest_run
Parameter	Type	Description
pipeline_id	String	Pipeline ID
pipeline_run_id	String	Pipeline running instance ID
executor_id	String	Executor ID
executor_name	String	Executor Name
stage_status_list	Array of stage_status_list objects	Phase Information List
status	String	Status
run_number	Integer	Running No.
trigger_type	String	Trigger Type
build_params	build_params object	Image build parameters
artifact_params	artifact_params object	Artifact source parameters
start_time	Long	Start time
end_time	Long	End Time
modify_url	String	Modify Page Address
detail_url	String	Details Page Address

**Table 7** stage_status_list
Parameter	Type	Description
name	String	Phase Name
sequence	Integer	SN
status	String	Status
start_time	String	Start time
end_time	String	End time.
id	String	Phase ID

**Table 8** build_params
Parameter	Type	Description
action	String	Combination Request Event Type
build_type	String	Branch-based or Tag-based Running
commit_id	String	Code Repository Submission ID
event_type	String	Running Event Type
merge_id	String	Combination Request ID
message	String	Code Repository Submission Information
source_branch	String	Source Branch
tag	String	Label
target_branch	String	Target Branch
codehub_id	String	Repo code repository ID
git_url	String	HTTPS address of the code repository
source_codehub_id	String	Source Repo Code Repository ID
source_codehub_url	String	Source Repo Code Repository Address
source_codehub_http_url	String	HTTP address of the source Repo code repository

**Table 9** artifact_params
Parameter	Type	Description
version	String	Package Version
branch_filter	String	Filtering Branches
package_name	String	Package Name
organization	String	Docker organization

Example Requests

This API is used to obtain the pipeline list. Set the start offset to 0 and the number to 10.

POST https://{endpoint}/v5/54f90b75fc1447b1b65e8d3a9f77923d/api/pipelines/list

{
  "offset" : 0,
  "limit" : 10,
  "name" : ""
}

Example Responses

Status code: 200

{
  "offset" : 0,
  "limit" : 10,
  "total" : 1,
  "pipelines" : [ {
    "pipeline_id" : "cd65d6f2dc17493e97eb5175f872761a",
    "name" : "New Pipeline - 20230222181032",
    "project_id" : "6428c2e2b4b64affa14ec80896695c49",
    "component_id" : "7bb171e9e9fc415dbd1666ceb68668da",
    "is_publish" : true,
    "is_collect" : false,
    "manifest_version" : "3.0",
    "create_time" : 1677060662000,
    "latest_run" : {
      "pipeline_id" : "cd65d6f2dc17493e97eb5175f872761a",
      "pipeline_run_id" : "88a195482b8a48a1808e87ec21565c2f",
      "executor_id" : "847a5317086c41798469d0868535943a",
      "executor_name" : "Beta environment account",
      "stage_status_list" : [ {
        "name" : "Merge Integration Branch",
        "sequence" : 0,
        "status" : "FAILED",
        "start_time" : "2023-02-22 18:12:25",
        "end_time" : "2023-02-22 18:12:32"
      }, {
        "name" : "Phase_1",
        "sequence" : 1,
        "status" : "INIT",
        "start_time" : null,
        "end_time" : null
      }, {
        "name" : "Combining Trunks",
        "sequence" : 1,
        "status" : "INIT",
        "start_time" : null,
        "end_time" : null
      } ],
      "status" : "FAILED",
      "run_number" : 1,
      "trigger_type" : "Manual",
      "build_params" : null,
      "artifact_params" : null,
      "start_time" : 1677060745000,
      "end_time" : 1677060752000
    }
  } ]
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes

See Error Codes.

Parent topic:Pipeline Management

Previous topic: Obtaining the Pipeline Status/Obtaining Pipeline Execution Details

Next topic: Deleting a Pipeline

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.