更新时间:2025-09-04 GMT+08:00
分享

获取任务构建记录列表(旧)

功能介绍

获取任务构建记录列表(旧)。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

job_id

String

参数解释

填写需要查询构建历史列表的构建任务ID。获取方法:在构建任务详情页,拷贝浏览器URL末尾的32位数字、字母组合的字符串,即为构建任务ID。

约束限制

不涉及。

取值范围

只能是英文字母和数字,长度为32个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

start_time

String

参数解释

区间开始时间。

约束限制

格式yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

默认取值

不涉及。

end_time

String

参数解释

区间结束时间。

约束限制

格式yyyy-MM-dd HH:mm:ss。

取值范围

不涉及。

默认取值

不涉及。

page_index

Integer

参数解释

分页页码,表示从此页开始查询, page_index大于等于0。

约束限制

大于等于0。

取值范围

0-2147483647

默认取值:

0

page_size

Integer

参数解释

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

约束限制

不涉及。

取值范围

1-100。

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

result object

参数解释

调用接口成功后返回的数据。

取值范围

不涉及。

error

String

参数解释

返回错误信息。

取值范围

不涉及。

status

String

参数解释

返回状态信息。

取值范围

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

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

表5 result

参数

参数类型

描述

health_score

String

参数解释

健康度。

取值范围

不涉及。

page_index

String

参数解释

分页页数。

取值范围

不涉及。

total_page

String

参数解释

总页数。

取值范围

不涉及。

total_record

String

参数解释

总条数。

取值范围

不涉及。

job_build_states

Array of BuildInfoRecord objects

参数解释

构建历史详情列表。

取值范围

不涉及。

表6 BuildInfoRecord

参数

参数类型

描述

number

Integer

参数解释

构建编号。

取值范围

不涉及。

build_time

Integer

参数解释

构建任务执行时间。

取值范围

不涉及。

start_time

Integer

参数解释

构建任务开始时间的时间戳。

取值范围

不涉及。

job_running_status

String

参数解释

构建任务的运行状态。

取值范围

不涉及。

state

String

参数解释

任务状态。

取值范围

不涉及。

user_id

String

参数解释

IAM用户ID。

取值范围

不涉及。

executor

String

参数解释

触发构建用户。

取值范围

不涉及。

nickname

String

参数解释

用户昵称。

取值范围

不涉及。

daily_build_number

String

参数解释

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

取值范围

不涉及。

trigger_type

String

参数解释

触发方式,可选值:手工触发(MANUAL),定时触发(TIMED_EXECUTION),代码更新触发(CODEHUB_TRIGGER),流水线触发(PIPELINE_TRIGGER)。

取值范围

● MANUAL:手工触发。

● TIMED_EXECUTION:定时触发。

● CODEHUB_TRIGGER:代码更新触发。

● PIPELINE_TRIGGER:流水线触发。

cost_time

Integer

参数解释

构建任务执行时间。

取值范围

不涉及。

commit_id

String

参数解释

代码提交的commit id。

取值范围

不涉及。

commit_info

commit_info object

参数解释

代码提交信息。

取值范围

不涉及。

build_type

String

参数解释

构建类型,分支构建、Tag构建、Commit构建。

取值范围

branch(分支构建),tag(Tag构建),commitId(Commit构建)。

code_branch

String

参数解释

代码仓分支。

取值范围

不涉及。

scm_type

String

参数解释

代码源类型。

取值范围

codehub、repo、github。

scm_web_url

String

参数解释

代码源地址。

取值范围

不涉及。

commit_detail_url

String

参数解释

代码提交记录信息地址(代码源为Repo)。

取值范围

不涉及。

表7 commit_info

参数

参数类型

描述

commit_id

String

参数解释

代码提交的commit id。

取值范围

不涉及。

created_at

String

参数解释

提交时间。

取值范围

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

响应示例

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

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

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档