Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Obtaining Pipeline Execution Records
Updated on 2025-09-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Pipeline Execution Records

Function

This API is used to obtain pipeline execution records.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/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

pipeline_id

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

status

No

Array of strings

Definition:

Pipeline status list.

Constraints:

N/A

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 pipeline is ignored.

Default value:

N/A

start_time

No

String

Definition:

Pipeline start time.

Constraints:

N/A

Value range:

The value can be a timestamp or in the YYYY-MM-DD HH:MM:SS format.

Default value:

N/A

end_time

No

String

Definition:

Pipeline end time.

Constraints:

N/A

Value range:

The value can be a timestamp or in the YYYY-MM-DD HH:MM:SS format.

Default value:

N/A

offset

No

Long

Parameter description:

Initial offset.

Constraints:

None.

Value range:

No less than 0.

Default value:

None.

limit

No

Long

Parameter description:

Number of records to be queried.

Constraints:

N/A

Value range:

No less than 0.

Default value:

N/A

sort_key

No

String

Definition:

Sorting field.

Constraints:

N/A

Value range:

start_time - pipeline start time.

Default value:

N/A

sort_dir

No

String

Definition:

Sorting rule.

Constraints:

N/A

Value range:

  • asc: by sorting field in ascending order.

  • desc: by sorting field in descending order.

Default value:

N/A

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 execution records.

Value range:

None.

pipeline_runs

Array of pipeline_runs objects

Parameter description:

Pipeline running information list.

Value range:

None.
Table 5 pipeline_runs

Parameter

Type

Description

pipeline_id

String

Definition:

Pipeline ID. Obtain the 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.

pipeline_run_id

String

Definition:

Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID.

Value range:

The value consists of 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 information list.

Value range:

None.

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

detail_url

String

Parameter description:

URL of the details page. If the region information in x-auth-token is empty, the details page URL is also empty.

Value range:

N/A

modify_url

String

Parameter description:

URL of the editing page. If the region information in x-auth-token is empty, the URL of the editing page is also empty.

Value range:

N/A
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 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

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 pipeline 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.

id

String

Parameter description:

Stage ID.

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

Parameter description:

Code repository commit ID.

Value range:

None.

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

This API is used to obtain pipeline execution records.

Set the start offset to 0, quantity to 10, start timestamp to 1677513600000, and end timestamp to 1678118399000, and sort the query results in descending order of the start time.

POST http://{endpoint}/v5/54f90b75fc1447b1b65e8d3a9f77923d/api/pipelines/e5460d1d403146a1935c2d4b68ef506c/pipeline-runs/list

{
  "offset" : 0,
  "limit" : 10,
  "status" : [ "COMPLETED", "RUNNING", "FAILED", "CANCELED", "PAUSED", "SUSPEND" ],
  "sort_key" : "start_time",
  "sort_dir" : "DESC",
  "start_time" : 1677513600000,
  "end_time" : 1678118399000
}

Example Responses

Status code: 200

OK

{
  "offset" : 0,
  "limit" : 10,
  "total" : 1,
  "pipeline_runs" : [ {
    "pipeline_id" : "24949d4f4453495f8e5a76f993af7f43",
    "pipeline_run_id" : "ddb7532cb0e948f2af7bb4397fc19864",
    "executor_id" : "847a5317086c41798469d0868535943a",
    "executor_name" : "Beta environment account",
    "stage_status_list" : [ {
      "name" : "Phase_1",
      "sequence" : 0,
      "status" : "COMPLETED",
      "start_time" : "2023-03-06 10:04:46",
      "end_time" : "2023-03-06 10:04:46"
    } ],
    "status" : "COMPLETED",
    "run_number" : 11,
    "trigger_type" : "Manual",
    "build_params" : {
      "action" : null,
      "build_type" : "branch",
      "commit_id" : "990ea057751d299f5575aac25bf97e88a60b461e",
      "event_type" : "Manual",
      "merge_id" : null,
      "message" : "Creating a Dockerfile",
      "source_branch" : null,
      "tag" : null,
      "target_branch" : "cloud_pipeline_release_1674026917209",
      "codehub_id" : "2111677704",
      "git_url" : "http://example.com/clsyz00001/aaaaa.git"
    },
    "artifact_params" : null,
    "start_time" : 1678066487000,
    "end_time" : 1678066488000
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

This API is used to obtain pipeline execution records.

Set the start offset to 0, quantity to 10, start timestamp to 1677513600000, and end timestamp to 1678118399000, and sort the query results in descending order of the start time.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
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 ListPipelineRunsSolution {

    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();
        ListPipelineRunsRequest request = new ListPipelineRunsRequest();
        request.withProjectId("{project_id}");
        request.withPipelineId("{pipeline_id}");
        ListPipelineRunsQuery body = new ListPipelineRunsQuery();
        List<String> listbodyStatus = new ArrayList<>();
        listbodyStatus.add("COMPLETED");
        listbodyStatus.add("RUNNING");
        listbodyStatus.add("FAILED");
        listbodyStatus.add("CANCELED");
        listbodyStatus.add("PAUSED");
        listbodyStatus.add("SUSPEND");
        body.withSortDir("DESC");
        body.withSortKey("start_time");
        body.withLimit(10L);
        body.withOffset(0L);
        body.withEndTime("1678118399000");
        body.withStartTime("1677513600000");
        body.withStatus(listbodyStatus);
        request.withBody(body);
        try {
            ListPipelineRunsResponse response = client.listPipelineRuns(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 pipeline execution records.

Set the start offset to 0, quantity to 10, start timestamp to 1677513600000, and end timestamp to 1678118399000, and sort the query results in descending order of the start time.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# 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 = ListPipelineRunsRequest()
        request.project_id = "{project_id}"
        request.pipeline_id = "{pipeline_id}"
        listStatusbody = [
            "COMPLETED",
            "RUNNING",
            "FAILED",
            "CANCELED",
            "PAUSED",
            "SUSPEND"
        ]
        request.body = ListPipelineRunsQuery(
            sort_dir="DESC",
            sort_key="start_time",
            limit=10,
            offset=0,
            end_time="1678118399000",
            start_time="1677513600000",
            status=listStatusbody
        )
        response = client.list_pipeline_runs(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 pipeline execution records.

Set the start offset to 0, quantity to 10, start timestamp to 1677513600000, and end timestamp to 1678118399000, and sort the query results in descending order of the start time.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
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.ListPipelineRunsRequest{}
	request.ProjectId = "{project_id}"
	request.PipelineId = "{pipeline_id}"
	var listStatusbody = []string{
        "COMPLETED",
	    "RUNNING",
	    "FAILED",
	    "CANCELED",
	    "PAUSED",
	    "SUSPEND",
    }
	sortDirListPipelineRunsQuery:= "DESC"
	sortKeyListPipelineRunsQuery:= "start_time"
	limitListPipelineRunsQuery:= int64(10)
	offsetListPipelineRunsQuery:= int64(0)
	endTimeListPipelineRunsQuery:= "1678118399000"
	startTimeListPipelineRunsQuery:= "1677513600000"
	request.Body = &model.ListPipelineRunsQuery{
		SortDir: &sortDirListPipelineRunsQuery,
		SortKey: &sortKeyListPipelineRunsQuery,
		Limit: &limitListPipelineRunsQuery,
		Offset: &offsetListPipelineRunsQuery,
		EndTime: &endTimeListPipelineRunsQuery,
		StartTime: &startTimeListPipelineRunsQuery,
		Status: &listStatusbody,
	}
	response, err := client.ListPipelineRuns(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