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 history page in your browser, and copy the 32-character string, which includes both digits and letters and appears in the URL immediately after /detail/history/. 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 can be obtained by calling the IAM service 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	Object	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 CreateBuildJobParameterResponse objects	Definition A list of build task execution 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 Task source. Range N/A

**Table 6** CreateBuildJobScmResponse
Parameter	Type	Description
branch	String	Definition Name of the code branch. Range N/A.
merge_target_url	String	Definition URL of the merge target. Range N/A
merge_target_web_url	String	Definition Website URL of the merge target. Range N/A
relative_target_dir	String	Definition Target directory. It is a relative path. Range N/A
branch_regex_message	String	Definition Information about regular expression verification for a branch. Range N/A
branch_regex	String	Definition Regular expression of the branch. Range N/A.
hook_id	String	Definition hook_id Range N/A
repo_commit_id	String	Definition Code commit ID of a repo. Range N/A
repo_exist	Boolean	Definition Check whether a repo already exists. Range true or false
disable_submodules	Boolean	Definition Whether the submodule update function is disabled. Range true or false
endpoint_id	String	Definition Endpoint ID. Range Use a mix of digits and lowercase letters.
build_tag	String	Definition Code tag. Range N/A
build_commit_id	String	Definition Code commit ID. Range N/A
checkout_name	String	Definition Name of the code checkout action. Range N/A
commit_message	String	Definition Code commit message. Range N/A
create_type	String	Definition Creation type. Range N/A
project_id	String	Definition CodeArts project ID. Range N/A
auto_build_info	auto_build_info object	Definition CodeArts project ID. Range N/A
name_with_namespace	String	Definition A name with namespace. Range N/A
merge_target	String	Definition Tag for merging. Range N/A
event_type	String	Definition Event type. Range push or push_events Default Value N/A
merge_id	String	Definition Merge request ID. Range N/A Default Value N/A
action	String	Definition Merge request information. Range N/A Default Value N/A
gitcode_repo_id	String	Definition GitCode repository ID. Range N/A Default Value N/A
workspace_name	String	Definition Workspace name of the code repository. Range N/A Default Value N/A
workspace_id	String	Definition Workspace ID of the code repository. Range N/A Default Value N/A
commit_id	String	Definition Code commit ID. Range N/A Default Value 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 The value can be branch (referencing the build source by branch), tag (referencing the build source by tag), or commitId (referencing the build source by commit ID).
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** auto_build_info
Parameter	Type	Description
ref	String	Definition Build reference, such as the Git branch name or tag. Range N/A
before	String	Definition Version information before the build completes. Range N/A
after	String	Definition Version information after the build completes. Range N/A

**Table 8** CreateBuildJobParameterResponse
Parameter	Type	Description
name	String	Definition Parameter definition name. The default value is hudson.model.StringParameterDefinition. Range N/A.
params	Array of CreateBuildJobParameterParamResponse objects	Definition Subparameters of build execution parameters. Range N/A.

**Table 9** CreateBuildJobParameterParamResponse
Parameter	Type	Description
name	String	Definition Parameter field name. Range N/A.
value	String	Definition Parameter field value. Range N/A.
limits	Array of LimitsParamResponse objects	Definition Restrictions on enumeration parameters. Range N/A.

**Table 10** LimitsParamResponse
Parameter	Type	Description
disable	String	Definition Whether enabled or not. The default value is 0, indicating "enabled". Range N/A.
display_name	String	Definition Parameter display name. Range N/A.
name	String	Definition Parameter name. Range N/A.

Example Requests

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

Example Responses

Status code: 200

{
  "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",
      "merge_target_url" : null,
      "merge_target_web_url" : null,
      "relative_target_dir" : null,
      "branch_regex" : null,
      "branch_regex_message" : null,
      "repo_exist" : true,
      "disable_submodules" : false,
      "endpoint_id" : null,
      "project_id" : "a287e712be6c404ca26e5f69040fa12b",
      "merge_id" : null,
      "event_type" : null,
      "enable_git_lfs" : true,
      "hook_id" : null,
      "repo_commit_id" : null,
      "commit_id" : "5cb9180bedf25e8c103d30cb0c924a4107336b06",
      "build_tag" : "tag_test",
      "build_commit_id" : "5cb9180bedf25e8c103d30cb0c924a4107336b06",
      "commit_message" : "initial commit",
      "auto_build_info" : null,
      "name_with_namespace" : null,
      "merge_target" : null,
      "gitcode_repo_id" : null,
      "workspace_name" : null,
      "workspace_id" : null,
      "checkout_name" : null,
      "create_type" : null,
      "action" : null
    } ],
    "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.

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

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

 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

Error Codes

See Error Codes.

Parent Topic: Build Task Management

Previous topic: Querying Task Status

Next topic: Obtaining Build Parameters on the Details Page

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot