Help Center/ CodeArts Build/ API Reference/ APIs/ Build Task Management/ Obtaining Build Task Information in a Pipeline
Updated on 2025-08-21 GMT+08:00

Obtaining Build Task Information in a Pipeline

Function

This API is used to obtain build task information in a pipeline.

Calling Method

For details, see Calling APIs.

URI

GET /v1/job/{job_id}/pipeline-info

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

job_id

Yes

String

Definition

Enter the ID of the build task whose history you want to query. To obtain this ID, open the build task details page in your browser, and copy the 32-character string, which includes both digits and letters, at the end of the URL.

Constraints

N/A.

Range

The value is 32 characters long. Only letters and digits are allowed.

Default Value

N/A.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

all

No

String

Definition

Enter true or false to determine if all parameters should be returned.

Constraints

N/A.

Range

true or false.

Default Value

true

check_param_used

No

String

Definition

This configuration identifies and removes unused parameters.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. (The value of the X-Subject-Token response header is the user token.) It is obtained by calling the IAM API. For details, see Obtaining an IAM User Token.

Constraints

Global tenant tokens are not supported. Use a region-level token whose scope is project.

Range

N/A.

Default Value

N/A.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

JobPipelineInfoItems object

Returned results for requesting build task information in a pipeline.

error

String

Definition

Returned error message.

Range

N/A.

status

String

Definition

Returned status information.

Range

success: The API call is successful.

fail: The API call failed.

Table 5 JobPipelineInfoItems

Parameter

Type

Description

scms

Array of CreateBuildJobScmResponse objects

Definition

Information about the code repository used during a build.

Range

N/A.

parameters

Array of JobPipelineInfoParameters objects

Definition

Parameters.

Range

N/A.

job_name

String

Definition

Task name.

Range

N/A.

job_name_massage

String

Definition

Task name information.

Range

N/A.

job_name_regex

String

Definition

Regular expression of the task name.

Range

N/A.

source_code

String

Definition

Regular expression of the task name.

Range

N/A.

Table 6 CreateBuildJobScmResponse

Parameter

Type

Description

branch

String

Definition

Name of the code branch.

Range

N/A.

url

String

Definition

Code repository address.

Range

N/A.

repo_id

String

Definition

Repo ID.

Range

N/A.

web_url

String

Definition

HTTPS address of the code repository.

Range

N/A.

scm_type

String

Definition

Repository type.

Range

repo, github, gitee, gerrit, gitcode, or codehub

is_auto_build

Boolean

Definition

Whether to trigger a build upon any code commit.

Range

true: Auto-build allowed.

false: Auto-build disallowed.

enable_git_lfs

Boolean

Definition

Whether to enable Git LFS.

Range

true: Git LFS enabled.

false: Git LFS disabled.

build_type

String

Definition

Build type. Options include build from a branch, tag, or commit.

Range

N/A.

depth

String

Definition

Clone depth. The clone depth is the number of recent commits that will be cloned. A larger value indicates more commits will be fetched.

Range

1–25.

end_point_id

String

Definition

Endpoint ID used for pulling code from services such as Git.

Range

N/A.

source

String

Definition

Source of the code repository.

Range

N/A.

group_name

String

Definition

Repository group name.

Range

N/A.

repo_name

String

Definition

Repository name.

Range

N/A.

Table 7 JobPipelineInfoParameters

Parameter

Type

Description

region

String

Definition

Region.

Range

N/A.

language

String

Definition

Language.

Range

N/A.

name

String

Definition

Name.

Range

N/A.

params

Array of JobPipelineInfoParamsItems objects

Definition

Parameter value.

Range

N/A.

Table 8 JobPipelineInfoParamsItems

Parameter

Type

Description

name

String

Definition

Parameter name.

Range

N/A.

value

String

Definition

Parameter value.

Range

N/A.

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/job/901878212b1a49be9c1a1054c272762a/pipeline-info

Example Responses

Status code: 200

OK

{
  "result" : {
    "scms" : [ {
      "url" : "git@codehub.devcloud.{region}.huawei.com:b4d3971c3988463b865f6f920846149e/aaa/Unit.git",
      "branch" : "master",
      "depth" : "1",
      "is_auto_build" : false,
      "repo_id" : "2111898074",
      "scm_type" : "codehub",
      "build_type" : "branch",
      "group_name" : "b4d3971c3988463b865f6f920846149e/aaa",
      "repo_name" : "Unit",
      "web_url" : "https://devcloud.{region}.huawei.com/codehub/2111898074/home"
    } ],
    "parameters" : [ {
      "name" : "hudson.model.StringParameterDefinition",
      "params" : [ {
        "name" : "name",
        "value" : "codeBranch"
      } ]
    } ],
    "job_name" : "testJobName",
    "job_name_massage" : "Enter a maximum of 115 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.",
    "job_name_regex" : "",
    "source_code" : "codeci"
  },
  "error" : null,
  "status" : "success"
}

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
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.codeartsbuild.v3.region.CodeArtsBuildRegion;
import com.huaweicloud.sdk.codeartsbuild.v3.*;
import com.huaweicloud.sdk.codeartsbuild.v3.model.*;


public class ShowJobPipelineInfoSolution {

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

        CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowJobPipelineInfoRequest request = new ShowJobPipelineInfoRequest();
        request.withJobId("{job_id}");
        try {
            ShowJobPipelineInfoResponse response = client.showJobPipelineInfo(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsbuild.v3 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 = CodeArtsBuildClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowJobPipelineInfoRequest()
        request.job_id = "{job_id}"
        response = client.show_job_pipeline_info(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/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 := codeartsbuild.NewCodeArtsBuildClient(
        codeartsbuild.CodeArtsBuildClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowJobPipelineInfoRequest{}
	request.JobId = "{job_id}"
	response, err := client.ShowJobPipelineInfo(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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.