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

Obtaining the Brief Build Information of a Specified Project

Function

This API is used to obtain the brief build information of a specified project.

Calling Method

For details, see Calling APIs.

URI

POST /v1/record/brief

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Details:

Number of items displayed on each page. The value of limit is no more than 100.

Constraints:

N/A

Value Range:

Only numbers that are 100 or less can be used.

Request Parameters

Table 2 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of strings

Definition

Build project ID (build_project_id).

Constraints

N/A.

Range

36-character UUID.

Default Value

N/A.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

Array of result objects

Definition

Result list.

Range

N/A.

error

Object

Definition

Error message.

Range

N/A.

status

String

Definition

Status information.

Range

success: The API call is successful.

fail: The API call failed.

Table 5 result

Parameter

Type

Description

project_id

String

Definition

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

Range

N/A.

brief_build_record_dtos

Array of BriefRecordItems objects

Definition

Brief build information list.

Range

N/A.

Table 6 BriefRecordItems

Parameter

Type

Description

id

String

Definition

Build task ID.

Range

N/A.

status

String

Definition

API response status.

Range

success: The API call is successful.

fail: The API call failed.

duration

Integer

Definition

Build duration.

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

Build queuing duration.

Range

N/A.

start_time

String

Definition

Start time.

Range

N/A.

finish_time

String

Definition

End time.

Range

N/A.

build_duration

Integer

Definition

Build duration of a subtask.

Range

N/A.

pending_duration

Integer

Definition

Wait time.

Range

N/A.

project_id

String

Definition

ID of the project to which the build task belongs.

Range

N/A.

build_no

Integer

Definition

The build number tracks each run of the build task. This parameter starts at 1, indicating the first build. It increments by 1 for every subsequent run.

Range

N/A.

branch

String

Definition

Code branch.

Range

N/A.

revision

String

Definition

Commit ID.

Range

N/A.

trigger_name

String

Definition

Name of the user who triggers the build.

Range

N/A.

daily_build_number

String

Definition

Build number. It starts from 1 every day.

Range

N/A.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

POST https://{endpoint}/v1/record/brief?limit=10

[ "string" ]

Example Responses

Status code: 200

OK

{
  "result" : [ {
    "project_id" : "string",
    "brief_build_record_dtos" : [ {
      "id" : "bf44443d-190b-4f21-8f6c-08cf511e8415",
      "status" : "SCHEDULE_FAILURE",
      "duration" : 0,
      "create_time" : "2024-08-31 10:58:02",
      "schedule_time" : "2024-08-12T02:31:01+0800",
      "queued_time" : "2024-08-12T02:31:01+0800",
      "start_time" : "2024-08-12T02:31:01+0800",
      "finish_time" : "2024-08-12T02:31:01+0800",
      "build_duration" : 0,
      "pending_duration" : 0,
      "project_id" : "string",
      "build_no" : 227,
      "branch" : "master",
      "revision" : "e980b883c1590363818225ec649d7cf161f0d49c",
      "trigger_name" : "devcloud_codeci_z00485259_03",
      "daily_build_number" : "string"
    } ]
  } ],
  "error" : { },
  "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
47
48
49
50
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.*;

import java.util.List;
import java.util.ArrayList;

public class ListBriefRecordSolution {

    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();
        ListBriefRecordRequest request = new ListBriefRecordRequest();
        List<String> listbodyListBriefRecordBody = new ArrayList<>();
        listbodyListBriefRecordBody.add("string");
        request.withBody(listbodyListBriefRecordBody);
        try {
            ListBriefRecordResponse response = client.listBriefRecord(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
32
33
34
# 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 = ListBriefRecordRequest()
        listListBriefRecordBodybody = [
            "string"
        ]
        request.body = listListBriefRecordBodybody
        response = client.list_brief_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
37
38
39
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.ListBriefRecordRequest{}
	var listListBriefRecordBodybody = []string{
        "string",
    }
	request.Body = &listListBriefRecordBodybody
	response, err := client.ListBriefRecord(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.