Updated on 2025-12-10 GMT+08:00

Obtaining All Run Logs

Function

This API is used to obtain all run logs of a specified build task.

Calling Method

For details, see Calling APIs.

URI

GET /v1/log/{job_id}/{build_no}/real-time-log

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.

build_no

Yes

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.

Constraints

The value is a positive integer.

Range

Use only numbers that are 1 or greater.

Default Value

1

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

start_offset

No

Integer

Definition

Where the query begins.

Constraints

N/A.

Range

Use only numbers that are 0 or greater.

end_offset

No

Integer

Definition

Where the query ends.

Constraints

N/A.

Range

Use only numbers that are 0 or greater.

sort

No

String

Definition

Sorting order.

Constraints

N/A.

Range

AES: ascending order

DESC: descending order

size

Yes

String

Definition

This parameter defines the length of the returned content. The default value is 1000.

Constraints

N/A.

Range

Use only numbers that are 0 or greater.

Default Value

1000

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

result object

Result.

error

String

Definition

Returned error message.

Range

N/A.

status

String

Definition

Returned status information.

Range

N/A.

Table 4 result

Parameter

Type

Description

has_more

Boolean

Definition

Whether there are remaining logs.

Range

true: There are remaining logs.

false: There are no remaining logs.

start_offset

String

Definition

The offset used to specify a starting point in the result returned by a query.

Range

The value consists of digits.

end_offset

String

Definition

The offset used to specify an end point in the result returned by a query.

Range

The value consists of digits.

log

String

Definition

Returned log content. Request again if it is empty.

Range

N/A.

location

String

Definition

Log source.

Range

N/A.

Example Requests

GET https://{endpoint}/v1/log/{job_id}/{build_no}/real-time-log

Example Responses

Status code: 200

OK

{
  "result" : {
    "start_offset" : 542993,
    "end_offset" : 657353,
    "log" : "[2023/12/21 15:44:18.743 GMT+08:00] [INFO] Building jar: ***//target/server-1.0 .jar\\n[2023/12/21 15:44:18.744 GMT+08:00] [INFO]...",
    "has_more" : false,
    "location" : "jenkins"
  },
  "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
47
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 DownloadBuildRealTimeLogSolution {

    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();
        DownloadBuildRealTimeLogRequest request = new DownloadBuildRealTimeLogRequest();
        request.withJobId("{job_id}");
        request.withBuildNo({build_no});
        try {
            DownloadBuildRealTimeLogResponse response = client.downloadBuildRealTimeLog(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
# 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 = DownloadBuildRealTimeLogRequest()
        request.job_id = "{job_id}"
        request.build_no = {build_no}
        response = client.download_build_real_time_log(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
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.DownloadBuildRealTimeLogRequest{}
	request.JobId = "{job_id}"
	request.BuildNo = int32({build_no})
	response, err := client.DownloadBuildRealTimeLog(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

Error Codes

See Error Codes.