Help Center/ CodeArts Build/ API Reference/ APIs/ Build Task Management/ Viewing Build Information of a Build Task
Updated on 2025-08-21 GMT+08:00

Viewing Build Information of a Build Task

Function

This API is used to view a build task's execution details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/job/{job_id}/info

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.

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

result object

Definition

Task information.

Range

N/A.

error

String

Definition

Returned error message.

Range

N/A.

status

String

Definition

Returned status information.

Range

success: The API call is successful.

fail: The API call failed.

Table 4 result

Parameter

Type

Description

id

String

Definition

Build task ID.

Range

N/A.

project_id

String

Definition

Build project ID. It uniquely corresponds to codeci_job_id.

Range

N/A.

project_permission_switch

Boolean

Definition

Whether project permissions are used.

Range

N/A.

build_time

String

Definition

Execution time.

Range

N/A.

charge_time

String

Definition

Charged time.

Range

N/A.

create_time

Long

Definition

Task creation time.

Range

N/A.

disabled

Boolean

Definition

Whether the task is disabled.

Range

true: Disabled.

false: Enabled.

favorite

Boolean

Definition

Whether the task is favorited.

Range

true: Favorited.

false: Unfavorited.

source_code

String

Definition

Code source.

Range

N/A.

running_status

String

Definition

Running status.

Range

N/A.

new_build

Boolean

Definition

Whether the task is rerun.

Range

true: The task is rerun.

false: The task is not rerun.

job_name

String

Definition

Task name.

Range

N/A.

is_copy

Boolean

Definition

Whether granted the permission for cloning the task.

Range

true: Granted the permission to clone the task.

false: Not granted the permission to clone the task.

is_delete

Boolean

Definition

Whether granted the permission for deleting the task.

Range

true: Granted the permission to delete the task.

false: Not granted the permission to delete the task.

is_execute

Boolean

Definition

Whether granted the permission for running the task.

Range

true: Granted the permission to run the task.

false: Not granted the permission to run the task.

is_forbidden

Boolean

Definition

Whether granted the permission for disabling the task.

Range

true: Granted the permission to disable the task.

false: Not granted the permission to disable the task.

is_manager

Boolean

Definition

Whether granted the permission for managing the task.

Range

true: Granted the permission to manage the task.

false: Not granted the permission to manage the task.

is_modify

Boolean

Definition

Whether granted the permission for modifying the task.

Range

true: Granted the permission to modify the task.

false: Not granted the permission to modify the task.

is_view

Boolean

Definition

Whether granted the permission for viewing the task.

Range

true: Granted the permission to view the task.

false: Not granted the permission to view the task.

last_build_status

String

Definition

Last build status.

Range

N/A.

last_build_time

Integer

Definition

Last build time.

Range

N/A.

health_score

Integer

Definition

Health score.

Range

N/A.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/job/901878212b1a49be9c1a1054c272762a/info

Example Responses

Status code: 200

OK

{
  "result" : {
    "id" : "f5af662119404ad187437cd272b5099b",
    "project_id" : "85caf40575794f989920-5216d1148af6",
    "project_permission_switch" : true,
    "build_time" : "27.51",
    "charge_time" : "15.17",
    "create_time" : "1717574458000",
    "disabled" : false,
    "favorite" : false,
    "source_code" : "test",
    "running_status" : "Finished",
    "new_build" : false,
    "job_name" : "jobname",
    "is_copy" : true,
    "is_delete" : true,
    "is_execute" : true,
    "is_forbidden" : true,
    "is_manager" : true,
    "is_modify" : true,
    "is_view" : true,
    "last_build_status" : "success",
    "last_build_time" : 1721793407000,
    "health_score" : 74
  },
  "status" : "success",
  "error" : null
}

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

    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();
        ShowJobInfoRequest request = new ShowJobInfoRequest();
        request.withJobId("{job_id}");
        try {
            ShowJobInfoResponse response = client.showJobInfo(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 = ShowJobInfoRequest()
        request.job_id = "{job_id}"
        response = client.show_job_info(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.ShowJobInfoRequest{}
	request.JobId = "{job_id}"
	response, err := client.ShowJobInfo(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.