Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Build Products on a Pipeline
Updated on 2025-09-08 GMT+08:00

Querying Build Products on a Pipeline

Function

Querying Build Products on a Pipeline

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/artifacts

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

pipeline_run_id

Yes

String

Definition:

Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run 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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

artifacts

Array of Artifact objects

Definition:

Artifact list of a pipeline.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 4 Artifact

Parameter

Type

Description

project_id

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

name

String

Definition:

Artifact name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

artifact_version

String

Definition:

Artifact version.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

upload_target

String

Definition:

Platform where the artifact is stored.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

artifact_package_type

String

Definition:

Artifact package type, for example, JAR.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

artifact_uri

String

Definition:

Path for storing files in the artifact repository.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

artifact_download_url_with_id

String

Definition:

Artifact repository download address.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

artifact_type

String

Definition:

Artifact type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

hash_code

Array of hash_code objects

Definition:

Hash code of the artifact.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

job_id

String

Definition:

Build task ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

build_no

Integer

Definition:

Build task No.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

daily_build_number

String

Definition:

Build task sequence number.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

file_size

String

Definition:

Artifact size.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 5 hash_code

Parameter

Type

Description

hash_type

String

Definition:

Hash algorithm.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

hash_value

String

Definition:

Hash value.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Example Requests

GET https://{endpoint}/v5/26726a24b3f247b4b49300b6f84fee61/api/pipelines/5f58d4f7b0a9450a889c3ccb58813f1c/pipeline-runs/9018898842af45b3a0546f9caa44e4d5/artifacts

Example Responses

Status code: 200

OK

{
  "artifacts" : [ {
    "project_id" : "26726a24b3f247b4b49300b6f84fee61",
    "job_id" : "545da7fc36a7492a841e1018a21d2f22",
    "build_no" : "1",
    "name" : "javaMavenDemo-1.0.jar",
    "file_size" : "2.18KB",
    "hash_code" : [ {
      "hash_type" : "SHA256",
      "hash_value" : "0fce55424a0514443f0bd612dcb25abb8de9f06572a2050ba8c6483352d5c5bd"
    } ],
    "daily_build_number" : "20240311.1",
    "upload_target" : "artifact",
    "artifact_version" : "20240311.1",
    "artifact_package_type" : "jar",
    "artifact_uri" : "/Build-TestBuildCheck-749/20240311.1/",
    "artifact_download_url_with_id" : "https://example.com/DevRepoServer/v1/files/download?file_id=d7c3c7b5f511483b8485cc58fc32f2ea&type=archive",
    "artifact_type" : "package"
  } ]
}

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

    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();
        ShowPipelineArtifactsRequest request = new ShowPipelineArtifactsRequest();
        request.withProjectId("{project_id}");
        request.withPipelineId("{pipeline_id}");
        request.withPipelineRunId("{pipeline_run_id}");
        try {
            ShowPipelineArtifactsResponse response = client.showPipelineArtifacts(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 = ShowPipelineArtifactsRequest()
        request.project_id = "{project_id}"
        request.pipeline_id = "{pipeline_id}"
        request.pipeline_run_id = "{pipeline_run_id}"
        response = client.show_pipeline_artifacts(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.ShowPipelineArtifactsRequest{}
	request.ProjectId = "{project_id}"
	request.PipelineId = "{pipeline_id}"
	request.PipelineRunId = "{pipeline_run_id}"
	response, err := client.ShowPipelineArtifacts(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.