文档首页/ 编译构建 CodeArts Build/ API参考/ 编译构建API/ 构建记录/ 获取指定工程的简要构建信息
更新时间:2025-08-21 GMT+08:00

获取指定工程的简要构建信息

功能介绍

获取指定工程的简要构建信息。

调用方法

请参见如何调用API

URI

POST /v1/record/brief

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

每页显示的条目数量,limit小于等于100。

约束限制

不涉及。

取值范围

只能使用数字,小于等于100。

默认取值:

10

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token

约束限制

不支持租户全局token,请使用scope为project的region级token。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

Array of strings

参数解释

build_project_id,构建工程ID。

约束限制

不涉及。

取值范围

36位UUID。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

Array of result objects

参数解释

结果列表。

取值范围

不涉及。

error

Object

参数解释

错误信息。

取值范围

不涉及。

status

String

参数解释

状态信息。

取值范围

● success:表示接口调用成功。

● fail:表示接口调用失败。

表5 result

参数

参数类型

描述

project_id

String

参数解释

CodeArts项目ID。构建任务所在项目的ID。

取值范围

不涉及。

brief_build_record_dtos

Array of BriefRecordItems objects

参数解释

简要构建信息列表。

取值范围

不涉及。

表6 BriefRecordItems

参数

参数类型

描述

id

String

参数解释

构建任务的ID。

取值范围

不涉及。

status

String

参数解释

接口响应状态。

取值范围

● success:表示接口调用成功。

● fail:表示接口调用失败。

duration

Integer

参数解释

构建时长。

取值范围

不涉及。

create_time

String

参数解释

创建时间。

取值范围

不涉及。

schedule_time

String

参数解释

构建下发时间。

取值范围

不涉及。

queued_time

String

参数解释

构建排队耗时。

取值范围

不涉及。

start_time

String

参数解释

开始时间。

取值范围

不涉及。

finish_time

String

参数解释

结束时间。

取值范围

不涉及。

build_duration

Integer

参数解释

子任务构建耗时。

取值范围

不涉及。

pending_duration

Integer

参数解释

等待时间。

取值范围

不涉及。

project_id

String

参数解释

所属的项目ID。

取值范围

不涉及。

build_no

Integer

参数解释

构建任务的构建编号,从1开始,每次构建递增1。

取值范围

不涉及。

branch

String

参数解释

代码分支。

取值范围

不涉及。

revision

String

参数解释

commitId。

取值范围

不涉及。

trigger_name

String

参数解释

触发者名称。

取值范围

不涉及。

daily_build_number

String

参数解释

构建编号,每日从1开始。

取值范围

不涉及。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

[ "string" ]

响应示例

状态码: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代码示例

SDK代码示例如下。

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

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码