Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Obtaining Pipeline Statuses in Batches

Updated on 2025-09-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Obtaining Pipeline Statuses in Batches

Function

This API is used to obtain pipeline status in batches. Only the data with execution records is returned.

Calling Method

For details, see Calling APIs.

URI

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

**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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	Yes	Array of strings	Definition: Pipeline ID list. Obtain an ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Value range: The value consists of 32 characters, including only digits and letters.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of PipelineLatestRun objects	Definition: Pipeline and its latest running information. Value range: N/A

**Table 5** PipelineLatestRun
Parameter	Type	Description
pipeline_id	String	Parameter description: Pipeline ID. Value range: 32 characters, including only digits and letters.
pipeline_run_id	String	Parameter description: Pipeline run ID. Value range: 32 characters, including only digits and letters.
executor_id	String	Parameter description: Executor ID. Value range: 32 characters, including only digits and letters.
executor_name	String	Parameter description: Executor name. Value range: None.
stage_status_list	Array of stage_status_list objects	Parameter description: Stage status information, including the detailed status information of each stage. Constraints: N/A
status	String	Definition: Pipeline run status. Value range: COMPLETED: The instance is completed. RUNNING: The instance is running. FAILED: The instance failed. CANCELED: The instance is canceled. PAUSED: The instance is paused. SUSPEND: The instance is suspended. IGNORED: The instance is ignored.
run_number	Integer	Parameter description: Pipeline running sequence number. Value range: No less than 1.
trigger_type	String	Definition: Trigger type. Value range: Manual: triggered manually. Scheduler: triggered by a scheduled task. MR: triggered by an MR. Push: triggered by a push event. CreateTag: triggered by a tag. Issue: triggered by an issue. Note: triggered by a comment.
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	Definition: Pipeline start time. Value range: N/A
end_time	Long	Definition: Pipeline end time. Value range: N/A
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 6** 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 value 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	Definition: Pipeline stage status. Value range: INIT: The stage is being initialized. QUEUED: The stage is queuing. RUNNING: The stage is running. CANCELED: The stage is canceled. COMPLETED: The stage is completed. FAILED: The stage is failed. SKIPPED: The stage is skipped. IGNORED: The stage is ignored. PAUSED: The stage is paused. SUSPEND: The stage is suspended. ASYNC_RUNNING: The stage is running asynchronously. ASYNC_FAILED: The stage failed during asynchronous execution. UNSELECTED: The stage is unselected. REDISPATCH: The stage is rescheduled.
start_time	String	Parameter description: Stage start time. Value range: None.
end_time	String	Parameter description: Stage end time. Value range: None.

**Table 7** build_params
Parameter	Type	Description
action	String	Definition: Merge request type. Value range: open: The merge request is opened. reopen: The merge request is reopened. update: The merge request is updated. merge: The merge request is merged.
build_type	String	Definition: Triggered by a branch or a tag. Value range: branch: triggered by a branch. tag: triggered by a tag.
commit_id	String	Definition: Code repository commit ID. Value range: The value contains 40 characters.
event_type	String	Definition: Type of a running event. Value range: Manual: triggered manually. Scheduler: triggered by a scheduled task. MR: triggered by an MR. Push: triggered by a push event. CreateTag: triggered by a tag. Issue: triggered by an issue. Note: triggered by a comment.
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 8** 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

Obtaining Pipeline Statuses in Batches

The pipeline ID is d19799d619424b2bb2625ec2d93ea087.

POST http://{endpoint}/v5/54f90b75fc1447b1b65e8d3a9f77923d/api/pipelines/status

[ "d19799d619424b2bb2625ec2d93ea087" ]

Example Responses

Status code: 200

[ {
  "pipeline_id" : "d19799d619424b2bb2625ec2d93ea087",
  "pipeline_run_id" : "ad6b7f66283a45be9c1f82b06c831e59",
  "executor_id" : "847a5317086c41798469d0868535943a",
  "executor_name" : "Beta environment account",
  "stage_status_list" : [ {
    "name" : "Phase_1",
    "sequence" : 0,
    "status" : "FAILED",
    "start_time" : "2023-03-04 16:48:09",
    "end_time" : "2023-03-04 16:50:11"
  } ],
  "status" : "FAILED",
  "run_number" : 2,
  "trigger_type" : "Manual",
  "build_params" : {
    "action" : null,
    "build_type" : "branch",
    "commit_id" : "fc93c34f906aeb1cc031e3f6f8b2baeac078ae4b",
    "event_type" : "Manual",
    "merge_id" : null,
    "message" : "init",
    "source_branch" : null,
    "tag" : null,
    "target_branch" : "test-lbdsb11",
    "codehub_id" : "2111699716",
    "git_url" : "http://example.com/clsyz00001/111.git"
  },
  "artifact_params" : null,
  "start_time" : 1677919688000,
  "end_time" : 1677919811000
} ]

SDK Sample Code

The SDK sample code is as follows.

Obtaining Pipeline Statuses in Batches

The pipeline ID is d19799d619424b2bb2625ec2d93ea087.

      
       
         
         
           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.*;

import java.util.List;
import java.util.ArrayList;

public class BatchShowPipelinesLatestStatusSolution {

    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();
        BatchShowPipelinesLatestStatusRequest request = new BatchShowPipelinesLatestStatusRequest();
        request.withProjectId("{project_id}");
        List<String> listbodyBody = new ArrayList<>();
        listbodyBody.add("d19799d619424b2bb2625ec2d93ea087");
        request.withBody(listbodyBody);
        try {
            BatchShowPipelinesLatestStatusResponse response = client.batchShowPipelinesLatestStatus(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());
        }
    }
}

          

        

      
     

Obtaining Pipeline Statuses in Batches

The pipeline ID is d19799d619424b2bb2625ec2d93ea087.

      
       
         
         
           # 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 = BatchShowPipelinesLatestStatusRequest()
        request.project_id = "{project_id}"
        listBodybody = [
            "d19799d619424b2bb2625ec2d93ea087"
        ]
        request.body = listBodybody
        response = client.batch_show_pipelines_latest_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

Obtaining Pipeline Statuses in Batches

The pipeline ID is d19799d619424b2bb2625ec2d93ea087.

      
       
         
         
           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.BatchShowPipelinesLatestStatusRequest{}
	request.ProjectId = "{project_id}"
	var listBodybody = []string{
        "d19799d619424b2bb2625ec2d93ea087",
    }
	request.Body = &listBodybody
	response, err := client.BatchShowPipelinesLatestStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     