Obtaining Build Task Details (Outdated)

Function

This API is used to obtain build task details.

Calling Method

For details, see Calling APIs.

URI

GET /v3/jobs/{job_id}/query

**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
get_all_params	No	String	Definition Enter true or false to determine if all parameters should be returned. Constraints N/A. Range true or false Default Value false

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	CreateBuildJobResponseVo object	Definition Template query result. Range N/A.
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** CreateBuildJobResponseVo
Parameter	Type	Description
arch	String	Definition CPU architecture of the server. Range x86-64 or arm.
project_id	String	Definition CodeArts project ID. ID of the project to which the build task belongs. Range A UUID. Use a 32-character string containing a mix of digits and letters.
job_name	String	Definition Build task name. Range Letters, digits, underscores (_), and hyphens (-) are allowed. The value can contain 1 to 115 characters.
auto_update_sub_module	String	Definition Whether submodules are automatically updated. Range false: Submodules are not updated. true: Submodules are updated.
flavor	String	Definition Executor specification. Range N/A.
host_type	String	Definition Host type. Range N/A.
build_config_type	String	Definition Build configuration type. It can be YAML or ACTION. Range YAML or ACTION.
build_if_code_updated	Boolean	Definition The switch that controls whether code commits trigger builds. Range true: Every code commit will trigger the build task. false: Code commits will not trigger the build task.
parameters	Array of CreateBuildJobParameterResponse objects	Definition A list of build task execution parameters. Range N/A.
group_id	String	Definition Task group ID. Range N/A.
timeout	CreateBuildTimeoutResponse object	Definition Timeout duration of a build task. Range N/A.
scms	Array of CreateBuildJobScmResponse objects	Definition Information about the code repository used during a build. Range N/A.
steps	Array of CreateBuildJobStepsResponse objects	Definition Build actions being executed. Range N/A.
triggers	Array of TriggerResponse objects	Definition A collection of scheduled task triggers. Range N/A.

**Table 6** 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 7** 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 8** 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.

**Table 9** CreateBuildTimeoutResponse
Parameter	Type	Description
limit	String	Definition Build task execution timeout. Range 0–4.
unit	String	Definition Time unit for timeout. Range seconds, minute, or hour.

**Table 10** 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 11** CreateBuildJobStepsResponse
Parameter	Type	Description
properties	Map<String,Object>	Definition Build action parameters. Range N/A.
module_id	String	Definition Build action ID. Range N/A.
name	String	Definition Build action name. Range N/A.
version	String	Definition Build action version. Range N/A.
enable	Boolean	Definition Whether to enable automatic build task. Range ● true: Enabled. ● false: Disabled.

**Table 12** TriggerResponse
Parameter	Type	Description
parameters	Array of ParameterItemResponse objects	Definition Custom parameter. Range N/A.
name	String	Definition Trigger type. Range N/A.

**Table 13** ParameterItemResponse
Parameter	Type	Description
name	String	Definition Custom parameter name. Range Custom parameter name. The length cannot exceed 128 characters. Only letters, digits, and underscores (_) are supported.
value	String	Definition Parameter value. Range Default value of the custom parameter. Max. 8,192 characters.

Status code: 400

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 18** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

GET https://{endpoint}/v3/jobs/48c66c6002964721be537cdc6ce0297b/query

Example Responses

Status code: 200

{
  "result" : {
    "steps" : null,
    "arch" : "x86-64",
    "project_id" : "a287e712be6c404ca26e5f69040fa12b",
    "job_name" : "oychap213i2",
    "auto_update_sub_module" : "false",
    "flavor" : "2u8g",
    "parameters" : [ {
      "name" : "hudson.model.StringParameterDefinition",
      "params" : [ {
        "name" : "name",
        "value" : "codeBranch",
        "limits" : null
      }, {
        "name" : "type",
        "value" : "normalparam",
        "limits" : null
      }, {
        "name" : "defaultValue",
        "value" : "master",
        "limits" : null
      }, {
        "name" : "description",
        "value" : "Code branch, predefined parameters",
        "limits" : null
      }, {
        "name" : "deletion",
        "value" : "false",
        "limits" : null
      }, {
        "name" : "defaults",
        "value" : "true",
        "limits" : null
      }, {
        "name" : "staticVar",
        "value" : "false",
        "limits" : null
      }, {
        "name" : "sensitiveVar",
        "value" : "false",
        "limits" : null
      } ]
    } ],
    "scms" : [ {
      "branch" : "master",
      "url" : "git@codehub.devcloud.{region}.huawei.com:soso-test00001/an.git",
      "is_auto_build" : false,
      "scm_type" : "codehub",
      "end_point_id" : null,
      "web_url" : "https://devcloud.{region}.huawei.com/codehub/2111746211/home",
      "source" : null,
      "build_type" : "branch",
      "depth" : "1",
      "repo_id" : "2111746211"
    } ],
    "host_type" : "devcloud"
  },
  "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 ListJobConfigSolution {

    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();
        ListJobConfigRequest request = new ListJobConfigRequest();
        request.withJobId("{job_id}");
        try {
            ListJobConfigResponse response = client.listJobConfig(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 = ListJobConfigRequest()
        request.job_id = "{job_id}"
        response = client.list_job_config(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.ListJobConfigRequest{}
	request.JobId = "{job_id}"
	response, err := client.ListJobConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     