Help Center/ CodeArts Build/ API Reference/ APIs/ CodeArts Build (Out-of-date)/ Obtaining Build Records of a Task (Outdated)
Updated on 2025-08-21 GMT+08:00

Obtaining Build Records of a Task (Outdated)

Function

This API is used to obtain build records of a task.

Calling Method

For details, see Calling APIs.

URI

GET /v3/jobs/{job_id}/build-info-records

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

start_time

Yes

String

Definition

Start time.

Constraints

The format follows yyyy-MM-dd HH:mm:ss.

Range

N/A.

Default Value

N/A.

end_time

Yes

String

Definition

End time.

Constraints

The format follows yyyy-MM-dd HH:mm:ss.

Range

N/A.

Default Value

N/A.

page_index

No

Integer

Definition

page_index indicates the index of the page to start the query from. The value is no less than 0.

Constraints

The value is no less than 0.

Range

0–2147483647

page_size

No

Integer

Definition

page_size indicates the number of items displayed on each page. The value is no more than 100.

Constraints

N/A.

Range

1–100

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

result object

Definition

Data returned after the API is successfully called.

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 result

Parameter

Type

Description

health_score

String

Definition

Health score.

Range

N/A.

page_index

String

Definition

Page index.

Range

N/A.

total_page

String

Definition

Total number of pages.

Range

N/A.

total_record

String

Definition

Total number of records.

Range

N/A.

job_build_states

Array of BuildInfoRecord objects

Definition

A list of build record details.

Range

N/A.

Table 6 BuildInfoRecord

Parameter

Type

Description

number

Integer

Definition

Build number.

Range

N/A.

build_time

Integer

Definition

Build task execution time.

Range

N/A.

start_time

Integer

Definition

Start timestamp of a build task.

Range

N/A.

job_running_status

String

Definition

Build task status.

Range

N/A.

state

String

Definition

Task status.

Range

N/A.

user_id

String

Definition

IAM user ID.

Range

N/A.

executor

String

Definition

The user who triggered the build.

Range

N/A.

nickname

String

Definition

Username.

Range

N/A.

daily_build_number

String

Definition

Build number. It starts from 1 every day.

Range

N/A.

trigger_type

String

Definition

Triggering mode. Options include MANUAL (manual execution), TIMED_EXECUTION (schedule), CODEHUB_TRIGGER (code change), or PIPELINE_TRIGGER (pipeline).

Range

● MANUAL: Manual trigger

● TIMED_EXECUTION: Scheduled trigger

● CODEHUB_TRIGGER: Code change trigger

● PIPELINE_TRIGGER: Pipeline trigger

cost_time

Integer

Definition

Build task execution time.

Range

N/A.

commit_id

String

Definition

Code commit ID.

Range

N/A.

commit_info

commit_info object

Definition

Code commit message.

Range

N/A.

build_type

String

Definition

Build number. It starts from 1 every day.

Range

N/A.

code_branch

String

Definition

Code repository branch.

Range

N/A.

scm_type

String

Definition

Code source type.

Range

codehub, repo, or github.

scm_web_url

String

Definition

Code source address.

Range

N/A.

commit_detail_url

String

Definition

Address of code commit record (Code source: Repo).

Range

N/A.

Table 7 commit_info

Parameter

Type

Description

commit_id

String

Definition

Code commit ID.

Range

N/A.

created_at

String

Definition

Commit time.

Range

N/A.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v3/jobs/{job_id}/build-info-records

Example Responses

Status code: 200

OK

{
  "result" : {
    "health_score" : "0",
    "page_index" : "0",
    "total_page" : "44",
    "total_record" : "44",
    "job_build_states" : [ {
      "number" : 44,
      "build_time" : 3525000,
      "start_time" : 1703554641000,
      "job_running_status" : "Finished",
      "state" : "SUCCESS",
      "user_id" : "ae22fd035f354cfa8d82a3f1c8940446",
      "executor" : "test",
      "nickname" : "021",
      "daily_build_number" : "20231226.1",
      "trigger_type" : "Manual",
      "commit_id" : "ffe2ee8b44a0b2683df86b44f8ec27d71baeae86",
      "cost_time" : 3525000,
      "commit_info" : {
        "commit_id" : "ffe2ee8b44a0b2683df86b44f8ec27d71baeae86",
        "created_at" : "2023-11-21T01:48:21.000+00:00"
      },
      "build_type" : "branch",
      "code_branch" : "master",
      "scm_type" : "codehub",
      "scm_web_url" : "https://test.huawei.com/codehub/2111750206/home",
      "commit_detail_url" : "https://test.huawei.com/codehub/2111750206/ffe2ee8b44a0b2683df86b44f8ec27d71baeae86/commitdetail"
    } ]
  },
  "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 ListBuildInfoRecordSolution {

    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();
        ListBuildInfoRecordRequest request = new ListBuildInfoRecordRequest();
        request.withJobId("{job_id}");
        try {
            ListBuildInfoRecordResponse response = client.listBuildInfoRecord(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 = ListBuildInfoRecordRequest()
        request.job_id = "{job_id}"
        response = client.list_build_info_record(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.ListBuildInfoRecordRequest{}
	request.JobId = "{job_id}"
	response, err := client.ListBuildInfoRecord(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.