Help Center/ CodeArts Pipeline/ API Reference/ API/ GitCode Pipeline/ Querying the Running Details of a GitCode Pipeline
Updated on 2025-11-12 GMT+08:00

Querying the Running Details of a GitCode Pipeline

Function

This API is used to query the running details of a GitCode pipeline.

Calling Method

For details, see Calling APIs.

URI

GET /v6/{domain_id}/api/pac/pipelines/actions/{pipeline_id}/{pipeline_run_id}

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

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 only digits and letters.

Default value:

N/A

pipeline_run_id

Yes

String

Definition:

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

Constraints:

N/A

Value range:

The value consists of 32 characters, including only digits and letters.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

pipeline_id

String

Definition:

Pipeline ID.

Value range:

The value consists of 32 characters, including digits and letters.

pipeline_name

String

Definition:

Pipeline name.

Value range:

N/A

pipeline_run_id

String

Definition:

Pipeline running ID.

Value range:

The value consists of 32 characters, including digits and letters.

pipeline_run_name

String

Definition:

Pipeline running name.

Value range:

N/A

start_time

String

Definition:

Time when a pipeline starts to run.

Value range:

N/A

end_time

String

Definition:

Time when a pipeline execution finished.

Value range:

N/A

status

String

Definition:

Pipeline running status.

Value range:

N/A

trigger_type

String

Definition:

Pipeline trigger type.

Value range:

N/A

actor

String

Definition:

User who executes the pipeline.

Value range:

N/A

run_number

String

Definition:

Pipeline running ID.

Value range:

N/A

commit_id

String

Definition:

Code commit ID.

Value range:

N/A

jobs

Array of PipelineRunJobInfo objects

Definition:

Pipeline running job details.

Value range:

N/A

Table 3 PipelineRunJobInfo

Parameter

Type

Description

name

String

Definition:

Job name.

Value range:

N/A

id

String

Definition:

Job ID.

Value range:

N/A

identifier

String

Definition:

Unique identifier of a job.

Value range:

N/A

condition

String

Definition:

Condition expression.

Value range:

N/A

status

String

Definition:

Job status.

Value range:

N/A

start_time

String

Definition:

Job start time.

Value range:

N/A

end_time

String

Definition:

Job end time.

Value range:

N/A

steps

Array of PipelineRunStepInfo objects

Definition:

Job steps.

Value range:

N/A

Table 4 PipelineRunStepInfo

Parameter

Type

Description

name

String

Definition:

Step name.

Value range:

N/A

id

String

Definition:

Step ID.

Value range:

N/A

task

String

Definition:

Task name in a step.

Value range:

N/A

status

String

Definition:

Step status.

Value range:

N/A

start_time

String

Definition:

Step start time.

Value range:

N/A

end_time

String

Definition:

Step end time.

Value range:

N/A

Example Requests

GET https://{endpoint}/v6/93b9fc6ffc6a4edc9ab049c1f0dbec4b/api/pac/pipelines/actions/e6533cbd78ca4b02a1b7b0e1b6428975/e36cd65545704c45afa8e025b336d3b1

Example Responses

Status code: 200

OK

{
  "pipeline_id" : "ca5fd6c21a2a454f89613cfa8cf687d5",
  "pipeline_name" : "pipe",
  "pipeline_run_id" : "e6533cbd78ca4b02a1b7b0e1b6428975",
  "pipeline_run_name" : "pipeRun",
  "start_time" : 1742440405000,
  "end_time" : 1742440405000,
  "status" : "FAILED",
  "trigger_type" : "Push",
  "actor" : "actor1",
  "run_number" : 1,
  "commit_id" : "abc",
  "file_commit_id" : "abc",
  "branch" : "main",
  "jobs" : {
    "name" : "job",
    "id" : "ca5fd6c21a2a454f89613cfa8cf687d5",
    "identifier" : "job_1",
    "condition" : "default",
    "status" : "FAILED",
    "start_time" : 1742440405000,
    "end_time" : 1742440405000
  }
}

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

    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();
        ShowActionsRunsDetailRequest request = new ShowActionsRunsDetailRequest();
        request.withDomainId("{domain_id}");
        request.withPipelineId("{pipeline_id}");
        request.withPipelineRunId("{pipeline_run_id}");
        try {
            ShowActionsRunsDetailResponse response = client.showActionsRunsDetail(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
# 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 = ShowActionsRunsDetailRequest()
        request.domain_id = "{domain_id}"
        request.pipeline_id = "{pipeline_id}"
        request.pipeline_run_id = "{pipeline_run_id}"
        response = client.show_actions_runs_detail(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
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.ShowActionsRunsDetailRequest{}
	request.DomainId = "{domain_id}"
	request.PipelineId = "{pipeline_id}"
	request.PipelineRunId = "{pipeline_run_id}"
	response, err := client.ShowActionsRunsDetail(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.