Help Center/ CodeArts Build/ API Reference/ APIs/ CodeArts Build (Out-of-date)/ Querying Build History in a Specified Period
Updated on 2025-08-21 GMT+08:00

Querying Build History in a Specified Period

Function

This API is used to query the history of a build task in a specified period.

Calling Method

For details, see Calling APIs.

URI

GET /v3/jobs/{job_id}/period-history

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

offset

Yes

Integer

Details:

Page number, indicating that the query starts from this page.

Constraints:

N/A

Value Range:

Only numbers that are 0 or greater can be used.

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.

start_time

Yes

String

Details:

Start time in the format of "YYYY-MM-DD".

Constraints:

The time range cannot exceed 30 days.

Value Range:

The value matches the regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$.

end_time

Yes

String

Details:

Start time in the format of "YYYY-MM-DD".

Constraints:

The time range cannot exceed 30 days.

Value Range:

The value matches the regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}$.

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

total

Integer

Definition

Total number of records.

Range

0–2147483647

history_records

Array of history_records objects

Definition

A list of build records.

Range

N/A.

Table 5 history_records

Parameter

Type

Description

record_id

String

Definition

Build record ID. It is a unique key.

Range

N/A.

job_id

String

Definition

Task ID.

Range

N/A.

build_number

Integer

Definition

Build number.

Range

N/A.

start_time

String

Definition

Build start time.

Range

N/A.

end_time

String

Definition

Build end time.

Range

N/A.

result

String

Definition

Build result.

Range

N/A.

branch

String

Definition

Code branch.

Range

N/A.

commit_id

String

Definition

Code commit ID.

Range

N/A.

commit_message

String

Definition

Commit message input by the user. This parameter has a value only when CodeArts Repo repositories are used.

Range

N/A.

executor

String

Definition

Name of the user who runs the build task.

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

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 10 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}/period-history?start_time=2021-01-04&end_time=2021-01-14&offset=0&limit=10

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "history_records" : {
    "record_id" : "20201230.1",
    "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46",
    "build_number" : 55,
    "start_time" : "2020-12-30T17:33:11+08:00",
    "end_time" : "2020-12-30T17:33:27+08:00",
    "result" : "FAILURE",
    "branch" : "master",
    "commit_id" : "2f37dd494927d2c6259417c58e5faeb72bfe7150",
    "commit_message" : "test",
    "executor" : "test",
    "trigger_type" : "Manual"
  }
}

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 ShowListPeriodHistorySolution {

    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();
        ShowListPeriodHistoryRequest request = new ShowListPeriodHistoryRequest();
        request.withJobId("{job_id}");
        try {
            ShowListPeriodHistoryResponse response = client.showListPeriodHistory(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 = ShowListPeriodHistoryRequest()
        request.job_id = "{job_id}"
        response = client.show_list_period_history(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.ShowListPeriodHistoryRequest{}
	request.JobId = "{job_id}"
	response, err := client.ShowListPeriodHistory(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.