Help Center/ CodeArts Build/ API Reference/ APIs/ Build Records/ Obtaining the Build Record List of a Specified Project
Updated on 2025-08-21 GMT+08:00

Obtaining the Build Record List of a Specified Project

Function

This API is used to obtain the build record list of a specified project.

Calling Method

For details, see Calling APIs.

URI

GET /v1/record/{build_project_id}/records

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

build_project_id

Yes

String

Definition

Build project ID.

Constraints

N/A.

Range

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

Default Value

N/A.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

page

No

Integer

Definition

The index of the page to start the query from.

Constraints

The value is no less than 0.

Range

N/A.

Default Value

1.

limit

No

Integer

Definition

Number of items displayed on each page.

Constraints

N/A.

Range

The value is no more than 100.

Default Value

10.

triggers

No

Array of strings

Definition

A list of trigger types to be searched for.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

branches

No

Array of strings

Definition

A list of branches to be searched for.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

tags

No

Array of strings

Definition

A list of tags to be searched for.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

from_date

No

String

Definition

Query start time.

Constraints

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

Range

N/A.

Default Value

N/A.

to_date

No

String

Definition

Query end time.

Constraints

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

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

result object

Definition

Project list.

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

pagination

pagination object

Definition

Pagination information.

Range

N/A.

data

Array of BuildRecord objects

Definition

Build records of a project.

Range

N/A.

Table 6 pagination

Parameter

Type

Description

page

Integer

Definition

Page index.

Range

N/A.

limit

Integer

Definition

Number of records per page.

Range

N/A.

total

Integer

Definition

Total number.

Range

N/A.

Table 7 BuildRecord

Parameter

Type

Description

id

String

Definition

Unique ID.

Range

N/A.

status

String

Definition

API response status.

Range

N/A.

status_code

Integer

Definition

Status code.

Range

N/A.

create_time

String

Definition

Creation time.

Range

N/A.

schedule_time

String

Definition

Build assignment time.

Range

N/A.

queued_time

String

Definition

Queuing time.

Range

N/A.

start_time

String

Definition

Start time.

Range

N/A.

finish_time

String

Definition

Completion time.

Range

N/A.

duration

Integer

Definition

Duration.

Range

N/A.

build_duration

Integer

Definition

Build time.

Range

N/A.

pending_duration

Integer

Definition

Wait time.

Range

N/A.

project_id

String

Definition

CodeArts project ID. ID of the project to which the build task belongs.

Range

N/A.

display_name

String

Definition

Subtask name.

Range

N/A.

trigger_name

String

Definition

Name of the user who triggers the build.

Range

N/A.

group_name

String

Definition

Repository group name.

Range

N/A.

execution_id

String

Definition

CloudOctopus task ID.

Range

N/A.

parameters

Array of parameters objects

Definition

A list of build execution parameters.

Range

N/A.

repository

String

Definition

Repository address.

Range

N/A.

branch

String

Definition

Branch name.

Range

N/A.

revision

String

Definition

Commit ID.

Range

N/A.

build_yml_path

String

Definition

YAML path.

Range

N/A.

build_yml_url

String

YAML address.

daily_build_number

String

Definition

Daily build number.

Range

N/A.

build_record_type

build_record_type object

Definition

Build record type.

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

scm_type

String

Definition

Type of the repository that serves as the code source.

Range

codehub, repo, or github.

scm_web_url

String

Definition

Code source address.

Range

N/A.

user_id

String

Definition

User ID.

Range

N/A.

build_no

String

Definition

Build number.

Range

N/A.

daily_build_no

String

Definition

Daily build number.

Range

N/A.

dev_cloud_build_type

String

Definition

Build type.

Range

N/A.

Table 8 parameters

Parameter

Type

Description

name

String

Definition

Parameter name.

Range

N/A.

secret

Boolean

Definition

Whether a parameter is private.

Range

true: The parameter is private.

false: The parameter is not private.

value

String

Definition

Parameter value.

Range

N/A.

type

String

Definition

Type.

Range

N/A.

Table 9 build_record_type

Parameter

Type

Description

rerun

Boolean

Definition

Whether a build is rerun.

Range

true: The build is rerun.

false: The build is not rerun.

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

record_type

String

Definition

Record type

Range

N/A.

is_rerun

Boolean

Definition

Whether returned or not.

Range

true: Returned.

false: Not returned.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/record/a3270d84-ddc7-4288-b985-f801871b260d/records

Example Responses

Status code: 200

OK

{
  "result" : {
    "pagination" : {
      "page" : 0,
      "limit" : 10,
      "total" : -1
    },
    "data" : [ {
      "id" : "534488f1-8f08-4e2b-9bbb-9f3f20e0708e",
      "status" : "ABORTED",
      "duration" : 0,
      "parameters" : [ {
        "name" : "codeBranch",
        "secret" : false,
        "value" : "master"
      } ],
      "repository" : "https://codehub.devcloud.{region}.huawei.com:6823252f543d4915b49892a5fd9f0ec3/APITestCreateMaven02.git",
      "branch" : "master",
      "revision" : "",
      "status_code" : 8,
      "create_time" : "2024-06-26T08:25:09.000+00:00",
      "schedule_time" : "2024-06-26T08:25:11.000+00:00",
      "queued_time" : "2024-06-26T08:25:09.000+00:00",
      "start_time" : "2024-06-26T08:25:09.000+00:00",
      "finish_time" : "2024-06-26T08:25:26.000+00:00",
      "build_duration" : 0,
      "pending_duration" : 0,
      "project_id" : "a3270d84-ddc7-4288-b985-f801871b260d",
      "display_name" : "APITest-getInfo-yCAdLM",
      "trigger_name" : "testUser",
      "group_name" : "",
      "execution_id" : "j_VCcmey1D",
      "build_yml_path" : ".cloudbuild/build.yml",
      "build_yml_url" : "https://codehub.devcloud.{region}.huawei.com:6823252f543d4915b49892a5fd9f0ec3/APITestCreateMaven02/blob/master/.cloudbuild/build.yml",
      "daily_build_number" : "20240626.2",
      "build_record_type" : {
        "trigger_type" : "MANUAL",
        "record_type" : "JOB"
      },
      "trigger_type" : "MANUAL",
      "scm_type" : "codehub",
      "scm_web_url" : "https://devcloud.{region}.huawei.com/codehub/2111857371/home",
      "user_id" : "ae22fd035f354cfa8d82a3f1c8940446",
      "build_no" : "2",
      "daily_build_no" : "20240626.2",
      "dev_cloud_build_type" : "branch"
    } ]
  },
  "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 ListRecordsSolution {

    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();
        ListRecordsRequest request = new ListRecordsRequest();
        request.withBuildProjectId("{build_project_id}");
        try {
            ListRecordsResponse response = client.listRecords(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 = ListRecordsRequest()
        request.build_project_id = "{build_project_id}"
        response = client.list_records(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.ListRecordsRequest{}
	request.BuildProjectId = "{build_project_id}"
	response, err := client.ListRecords(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.