Help Center/ CodeArts Pipeline/ API Reference/ API/ GitCode Pipeline/ Querying GitCode Pipeline Execution Records
Updated on 2025-11-12 GMT+08:00

Querying GitCode Pipeline Execution Records

Function

This API is used to query GitCode pipeline execution records.

Calling Method

For details, see Calling APIs.

URI

POST /v6/{domain_id}/api/pac/pipelines/actions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition:

Tenant 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 body parameters

Parameter

Mandatory

Type

Description

page

No

Long

Definition:

Page number for pagination query.

Constraints:

N/A

Value range:

The value is greater than 0.

Default value:

N/A

page_size

No

String

Definition:

Number of records on each page.

Constraints:

N/A

Value range:

The value is fixed at 20.

Default value:

N/A

https_url

Yes

String

Definition:

Code source address.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

pipeline_name

No

String

Definition:

Pipeline name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

file_path

No

String

Definition:

File path.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

pipeline_run_name

No

String

Definition:

Name of the pipeline operator.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

event

No

String

Definition:

Pipeline trigger type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

actor

No

String

Definition:

Pipeline creator name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

branch

No

String

Definition:

Code source branch.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

status

No

String

Definition:

Pipeline running status.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

offset

No

Integer

Definition:

Query offset.

Constraints:

≥ 0

Value range:

N/A

Default value:

0.

limit

No

Integer

Definition:

Page size.

Constraints:

≥ 0

Value range:

N/A

Default value:

10.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

offset

Integer

Definition:

Query offset.

Constraints:

≥ 0

Value range:

N/A

Default value:

0.

limit

Integer

Definition:

Page size.

Constraints:

≥ 0

Value range:

N/A

Default value:

10.

total

Long

Definition:

Total number of queried pipelines.

Value range:

N/A

success_times

Long

Definition:

Number of pipelines that are successfully executed.

Value range:

N/A

failed_times

Long

Definition:

Number of pipelines that fail to run.

Value range:

N/A

pipeline_runs

Array of PipelineRunActions objects

Definition:

Pipeline execution history.

Value range:

N/A

Table 4 PipelineRunActions

Parameter

Type

Description

pipeline_id

String

Definition:

Pipeline ID.

Value range:

N/A

pipeline_run_id

String

Definition:

Pipeline run ID.

Value range:

N/A

actor

String

Definition:

Pipeline operator.

Value range:

N/A

pipeline_name

String

Definition:

Pipeline name.

Value range:

N/A

status

String

Definition:

Pipeline running status.

Value range:

N/A

run_number

String

Definition:

Pipeline run ID.

Value range:

N/A

event

String

Definition:

Pipeline trigger type.

Value range:

N/A

branch

String

Definition:

Code source branch.

Value range:

N/A

start_time

String

Definition:

Time when the pipeline starts to be executed.

Value range:

N/A

end_time

String

Definition:

Time when the pipeline stops running.

Value range:

N/A

commit_id

String

Definition:

Commit record of the code source.

Value range:

The value contains 40 characters.

pipeline_run_name

String

Definition:

Name of the pipeline operator.

Value range:

N/A

https_url

String

Definition:

Pipeline link.

Value range:

N/A

file_path

String

Definition:

YAML file path.

Value range:

N/A

Example Requests

POST https://{endpoint}/v6/93b9fc6ffc6a4edc9ab049c1f0dbec4b/api/pac/pipelines/actions

{
  "offset" : 0,
  "limit" : 10,
  "https_url" : "https://example.com/pipeline/runs",
  "pipeline_name" : "MyPipeline",
  "file_path" : "/path/to/file",
  "pipeline_run_name" : "Run_2023_09_15",
  "event" : "push",
  "actor" : "username123",
  "branch" : "main",
  "status" : "success"
}

Example Responses

Status code: 200

OK

{
  "total" : 100,
  "offset" : 0,
  "limit" : 10,
  "success_times" : 75,
  "failed_times" : 25,
  "pipeline_runs" : [ {
    "pipeline_id" : "pipeline_001",
    "pipeline_run_id" : "run_001",
    "actor" : "user123",
    "pipeline_name" : "Main Pipeline",
    "status" : "success",
    "run_number" : "1",
    "event" : "commit",
    "branch" : "main",
    "start_time" : "2023-09-15T12:00:00Z",
    "end_time" : "2023-09-15T12:30:00Z",
    "commit_id" : "abc123def456",
    "pipeline_run_name" : "Run on main branch",
    "https_url" : "https://example.com/pipeline/run/1",
    "file_path" : "/path/to/file"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

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

    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();
        ListActionsPipelineRunsRequest request = new ListActionsPipelineRunsRequest();
        request.withDomainId("{domain_id}");
        ActionsPipelineRunsQueryDTO body = new ActionsPipelineRunsQueryDTO();
        body.withStatus("success");
        body.withBranch("main");
        body.withActor("username123");
        body.withEvent("push");
        body.withPipelineRunName("Run_2023_09_15");
        body.withFilePath("/path/to/file");
        body.withPipelineName("MyPipeline");
        body.withHttpsUrl("https://example.com/pipeline/runs");
        request.withBody(body);
        try {
            ListActionsPipelineRunsResponse response = client.listActionsPipelineRuns(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());
        }
    }
}
 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
# 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 = ListActionsPipelineRunsRequest()
        request.domain_id = "{domain_id}"
        request.body = ActionsPipelineRunsQueryDTO(
            status="success",
            branch="main",
            actor="username123",
            event="push",
            pipeline_run_name="Run_2023_09_15",
            file_path="/path/to/file",
            pipeline_name="MyPipeline",
            https_url="https://example.com/pipeline/runs"
        )
        response = client.list_actions_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)
 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
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.ListActionsPipelineRunsRequest{}
	request.DomainId = "{domain_id}"
	statusActionsPipelineRunsQueryDto:= "success"
	branchActionsPipelineRunsQueryDto:= "main"
	actorActionsPipelineRunsQueryDto:= "username123"
	eventActionsPipelineRunsQueryDto:= "push"
	pipelineRunNameActionsPipelineRunsQueryDto:= "Run_2023_09_15"
	filePathActionsPipelineRunsQueryDto:= "/path/to/file"
	pipelineNameActionsPipelineRunsQueryDto:= "MyPipeline"
	request.Body = &model.ActionsPipelineRunsQueryDto{
		Status: &statusActionsPipelineRunsQueryDto,
		Branch: &branchActionsPipelineRunsQueryDto,
		Actor: &actorActionsPipelineRunsQueryDto,
		Event: &eventActionsPipelineRunsQueryDto,
		PipelineRunName: &pipelineRunNameActionsPipelineRunsQueryDto,
		FilePath: &filePathActionsPipelineRunsQueryDto,
		PipelineName: &pipelineNameActionsPipelineRunsQueryDto,
		HttpsUrl: "https://example.com/pipeline/runs",
	}
	response, err := client.ListActionsPipelineRuns(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

Error Codes

See Error Codes.