On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
SDK Sample Code
Status Codes
Error Codes

Show all

Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Obtaining Pipeline List/Pipeline Execution Status in a Project

Obtaining Pipeline List/Pipeline Execution Status in a Project

Updated on 2025-03-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to obtain pipeline list and pipeline execution status in a project.

Calling Method

For details, see Calling APIs.

URI

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

**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 header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints: None. Value range: None. Default value: None.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
project_id	No	String	Parameter description: CodeArts project ID. Constraints: N/A Options: Each project ID contains 32 characters. Default value: N/A
project_ids	No	Array of strings	Parameter description: List of CodeArts project IDs. Constraints: None. Value range: Each project ID contains 32 characters. Default value: None.
component_id	No	String	Parameter description: Microservice ID. Constraints: None. Value range: 32 characters. Default value: None.
name	No	String	Parameter description: Pipeline name. Fuzzy search is supported. Constraints: None. Value range: None. Default value: None.
status	No	Array of strings	Parameter description: Pipeline status list. Constraints: N/A. Value Range: COMPLETED: completed; RUNNING: running; FAILED: failed; CANCELED: canceled; PAUSED: paused; SUSPEND: suspended; IGNORED: ignored. Default value: N/A.
is_publish	No	Boolean	Parameter description: Whether the pipeline is a change-triggered pipeline. Constraints: N/A Options: true: change-triggered pipeline; false: not a change-triggered pipeline. Default value: N/A properties:
creator_id	No	String	Parameter description: Creator ID. Constraints: N/A Options: Each ID contains 32 characters. Default value: N/A
creator_ids	No	Array of strings	Parameter description: Creator ID list. Constraints: None. Value range: Each ID contains 32 characters. Default value: None.
executor_ids	No	Array of strings	Parameter description: Executor ID list. Constraints: None. Value range: Each ID contains 32 characters. Default value: None.
start_time	No	String	Parameter description: Start time. Constraints: None. Value range: None. Default value: None.
end_time	No	String	Parameter description: End time. Constraints: None. Value range: None. Default value: None.
offset	No	Long	Parameter description: Initial offset. Constraints: None. Value range: None. Default value: None.
limit	No	Long	Parameter description: Number of records to be queried. Constraints: None. Value range: None. Default value: None.
sort_key	No	String	Parameter description: Sorting field name. Constraints: None. Value range: name: pipeline name; create_time: pipeline creation time; update_time: pipeline updating time. Default value: None.
sort_dir	No	String	Parameter description: Sorting rule. Constraints: None. Value range: asc: ascending order; desc: descending order. Default value: None.
group_path_id	No	String	Parameter description: Pipeline group ID. Constraints: None. Value range: None. Default value: None.
by_group	No	Boolean	Parameter description: Whether to query by group. Constraints: None. Value range: None. Default value: None.
is_banned	No	Boolean	Parameter description: Whether to include disabled pipelines. Constraints: N/A Options: N/A Default value: N/A
query_new	No	Boolean	Parameter description: Whether to query only the pipelines of the new version. Constraints: None. Value range: None. Default value: true.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
offset	Integer	Parameter description: Initial offset. Value range: None.
limit	Integer	Parameter description: Number of queried records. Value range: None.
total	Integer	Parameter description: Total number of records. Value range: None.
pipelines	Array of pipelines objects	Parameter description: Pipeline. Value range: None.

**Table 5** pipelines
Parameter	Type	Description
pipeline_id	String	Parameter description: Pipeline ID. Value range: 32 characters, including only digits and letters.
name	String	Parameter description: Pipeline name. Value range: The value can contain only letters, digits, hyphens (-), and underscores (_). The length is 1128 characters.
project_id	String	Parameter description: Project ID. Value range: 32 characters, including only digits and letters.
project_name	String	Parameter description: Project name. Value range: None.
component_id	String	Parameter description: Component ID. Value range: None.
is_publish	Boolean	Parameter description: Whether the pipeline is a change-triggered pipeline. Value Range: The value can be "true" or "false".
is_collect	Boolean	Parameter description: Whether to add the pipeline to favorites. Value Range: The value can be "true" or "false".
manifest_version	String	Parameter description: Pipeline version. Value range: The default value is 3.0.
create_time	Long	Parameter description: Creation time. Value range: None.
latest_run	latest_run object	Parameter description: Latest running information. Value range: None.
convert_sign	Integer	Parameter description: Sign of converting an old version to a new version. Value range: None.

**Table 6** latest_run
Parameter	Type	Description
pipeline_id	String	Parameter description: Pipeline ID. Value range: None.
pipeline_run_id	String	Parameter description: Pipeline run ID. Value range: None.
executor_id	String	Parameter description: Executor ID. Value range: None.
executor_name	String	Parameter description: Executor name. Value range: None.
stage_status_list	Array of stage_status_list objects	Stage information list.
status	String	Parameter description: Pipeline run status. Value Range: COMPLETED: completed; RUNNING: running; FAILED: failed; CANCELED: canceled; PAUSED: paused; SUSPEND: suspended; IGNORED: ignored.
run_number	Integer	Parameter description: Pipeline running sequence number. Value range: No less than 1.
trigger_type	String	Parameter description: Trigger type. Value range: Manual: manual trigger; Scheduler: scheduled task; Rollback: rollback execution; Webhook, which includes: CreateTag: tag trigger; Note: Gitee repository comment; Issue: Gitee repository issue; MR: merge request; Push: code push.
build_params	build_params object	Parameter description: Build parameters. Value range: None.
artifact_params	artifact_params object	Parameter description: Artifact parameters. Value range: None.
start_time	Long	Parameter description: Start time. Value range: None.
end_time	Long	Parameter description: End time. Value range: None.
modify_url	String	Parameter description: Address of the editing page. Value range: None.
detail_url	String	Parameter description: Address of the details page. Value range: None.

**Table 7** stage_status_list
Parameter	Type	Description
name	String	Parameter description: Stage name. Value range: Enter only letters, digits, hyphens (-), underscores (_), commas (,), semicolons (;), colons (:), periods (.), slashes (/), parentheses (), and spaces. The name cannot start or end with a space, and the length is 1128 characters.
sequence	Integer	Parameter description: Stage sequence number. The value 0 indicates the first pipeline stage. Value range: No less than 0.
status	String	Parameter description: Pipeline stage status. Value Range: INIT: initialization; QUEUED: queuing; RUNNING: running; CANCELED: canceled; COMPLETED: completed; FAILED: failed; SKIPPED: skipped; IGNORED: ignored; PAUSED: paused, SUSPEND: suspended; ASYNC_RUNNING: asynchronous running; ASYNC_FAILED: asynchronous failure; UNSELECTED: not selected; REDISPATCH: rescheduling.
start_time	String	Parameter description: Stage start time. Value range: None.
end_time	String	Parameter description: Stage end time. Value range: None.
id	String	Parameter description: Stage ID. Value range: None.

**Table 8** build_params
Parameter	Type	Description
action	String	Parameter description: Merge request event type. Value range: The value can be open, reopen, update, or merge.
build_type	String	Parameter description: Whether to trigger by branch or tag. Value range: branch: triggered by a branch; tag: triggered by a tag.
commit_id	String	Parameter description: Code repository commit ID. Value range: None.
event_type	String	Parameter description: Event type for running. Value range: Manual: manual trigger; Scheduler: scheduled task; Rollback: rollback execution; Webhook, which includes: CreateTag: tag trigger; Note: Gitee repository comment; Issue: Gitee repository issue; MR: merge request; Push: code push.
merge_id	String	Parameter description: Merge request ID. Value range: None.
message	String	Parameter description: Code commit message. Value range: None.
source_branch	String	Parameter description: Source branch. Value range: None.
tag	String	Parameter description: Tag. Value range: None.
target_branch	String	Parameter description: Target branch. Value range: None.
codehub_id	String	Parameter description: Repo code repository ID. Value range: None.
git_url	String	Parameter description: HTTPS address of the code repository. Value range: None.
source_codehub_id	String	Parameter description: ID of the source Repo code repository. Value range: None.
source_codehub_url	String	Parameter description: Address of the source Repo code repository. Value range: None.
source_codehub_http_url	String	Parameter description: HTTP address of the source Repo code repository. Value range: None.

**Table 9** artifact_params
Parameter	Type	Description
version	String	Parameter description: Package version. Value range: None.
branch_filter	String	Parameter description: Branch filter. Value range: None.
package_name	String	Parameter description: Package name. Value range: None.
organization	String	Parameter description: Docker organization. Value range: None.

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
    }
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Java
Python
Go
More

This API is used to obtain the pipeline list.

Set the start offset to 0 and the number to 10.

      
       
         
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartspipeline.v2.region.CodeArtsPipelineRegion;
import com.huaweicloud.sdk.codeartspipeline.v2.*;
import com.huaweicloud.sdk.codeartspipeline.v2.model.*;


public class ListPipelinesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>"))
                .build();
        ListPipelinesRequest request = new ListPipelinesRequest();
        request.withProjectId("{project_id}");
        ListPipelineQuery body = new ListPipelineQuery();
        body.withLimit(10L);
        body.withOffset(0L);
        body.withName("");
        request.withBody(body);
        try {
            ListPipelinesResponse response = client.listPipelines(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

        

      
     

This API is used to obtain the pipeline list.

Set the start offset to 0 and the number to 10.

      
       
         
         # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartspipeline.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsPipelineClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListPipelinesRequest()
        request.project_id = "{project_id}"
        request.body = ListPipelineQuery(
            limit=10,
            offset=0,
            name=""
        )
        response = client.list_pipelines(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      
     

This API is used to obtain the pipeline list.

Set the start offset to 0 and the number to 10.

      
       
         
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPipelinesRequest{}
	request.ProjectId = "{project_id}"
	limitListPipelineQuery:= int64(10)
	offsetListPipelineQuery:= int64(0)
	nameListPipelineQuery:= ""
	request.Body = &model.ListPipelineQuery{
		Limit: &limitListPipelineQuery,
		Offset: &offsetListPipelineQuery,
		Name: &nameListPipelineQuery,
	}
	response, err := client.ListPipelines(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

This API is used to obtain the pipeline list.

Set the start offset to 0 and the number to 10.

      
       
         
         package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartspipeline.v2.region.CodeArtsPipelineRegion;
import com.huaweicloud.sdk.codeartspipeline.v2.*;
import com.huaweicloud.sdk.codeartspipeline.v2.model.*;


public class ListPipelinesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>"))
                .build();
        ListPipelinesRequest request = new ListPipelinesRequest();
        request.withProjectId("{project_id}");
        ListPipelineQuery body = new ListPipelineQuery();
        body.withLimit(10L);
        body.withOffset(0L);
        body.withName("");
        request.withBody(body);
        try {
            ListPipelinesResponse response = client.listPipelines(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

        

      
     

This API is used to obtain the pipeline list.

Set the start offset to 0 and the number to 10.

      
       
         
         # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartspipeline.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsPipelineClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListPipelinesRequest()
        request.project_id = "{project_id}"
        request.body = ListPipelineQuery(
            limit=10,
            offset=0,
            name=""
        )
        response = client.list_pipelines(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

        

      
     

This API is used to obtain the pipeline list.

Set the start offset to 0 and the number to 10.

      
       
         
         package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPipelinesRequest{}
	request.ProjectId = "{project_id}"
	limitListPipelineQuery:= int64(10)
	offsetListPipelineQuery:= int64(0)
	nameListPipelineQuery:= ""
	request.Body = &model.ListPipelineQuery{
		Limit: &limitListPipelineQuery,
		Offset: &offsetListPipelineQuery,
		Name: &nameListPipelineQuery,
	}
	response, err := client.ListPipelines(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

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 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.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot