Help Center/ CodeArts Build/ API Reference/ APIs/ CodeArts Build APIs (Unavailable Soon)/ Obtaining Build Record Information (Unavailable Soon)
Updated on 2025-08-21 GMT+08:00

Obtaining Build Record Information (Unavailable Soon)

Function

This API is used to obtain build record information.

Calling Method

For details, see Calling APIs.

URI

GET /v3/jobs/{job_id}/{build_no}/record-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.

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

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

success

Boolean

Definition

Status.

Range

N/A.

message

String

Definition

Message.

Range

N/A.

err_code

String

Definition

Error code.

Range

N/A.

result

result object

Definition

Data returned after the API is successfully called.

Range

N/A.

Table 4 result

Parameter

Type

Description

id

String

Definition

ID.

Range

N/A.

buildProjectId

String

Definition

Build project ID. It uniquely corresponds to codeci_job_id.

Range

N/A.

buildRecordId

String

Definition

Build record ID.

Range

N/A.

parentRecordId

String

Definition

Parent build record ID.

Range

N/A.

devcloudProjectId

String

Definition

Project ID.

Range

N/A.

codeciJobId

String

Definition

Task ID. It uniquely corresponds to build_project_id.

Range

N/A.

userId

String

Definition

User ID.

Range

N/A.

buildNo

Integer

Definition

Build number.

Range

N/A.

dailyBuildNum

String

Definition

Daily build number. It starts from 1 every day.

Range

N/A.

executionId

String

Definition

CloudOctopus task ID.

Range

N/A.

repoName

String

Definition

Code repository name.

Range

N/A.

repoId

String

Definition

Code repository ID.

Range

N/A.

branch

String

Definition

Repository branch.

Range

N/A.

tag

String

Definition

Repository tag.

Range

N/A.

commit

String

Definition

Repository commit ID.

Range

N/A.

commitMessage

String

Definition

Repository commit message.

Range

N/A.

commitCreateTime

String

Definition

Commit creation time.

Range

N/A.

triggerType

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

buildType

String

Definition

Build type. Options include build from a branch, tag, or commit.

Range

branch, tag, and commitId.

status

String

Definition

Build status.

Range

N/A.

domainId

String

Definition

Tenant ID.

Range

N/A.

createTime

String

Definition

Build task creation time.

Range

N/A.

scheduleTime

String

Definition

Build assignment time.

Range

N/A.

queuedTime

String

Definition

Build queuing duration.

Range

N/A.

startTime

String

Definition

Build start time.

Range

N/A.

runnableTime

String

Definition

Time when CloudOctopus starts the build process.

Range

N/A.

finishTime

String

Definition

Build end time.

Range

N/A.

duration

Float

Definition

Build duration.

Range

N/A.

recordStatus

String

Definition

Build task record status.

Range

N/A.

usePrivateSlave

Integer

Definition

Whether a custom executor is used.

Range

N/A.

region

String

Definition

The region where the tenant is located.

Range

N/A.

errMsg

String

Definition

Error message.

Range

N/A.

buildConfigType

String

Definition

Build configuration type. It can be YAML or ACTION.

Range

YAML or ACTION.

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}/v3/jobs/cb5fa20de5fd4cf8be681d4bd6fdd2f6/61/record-info

Example Responses

Status code: 200

OK

{
  "success" : true,
  "message" : "",
  "err_code" : "",
  "result" : {
    "id" : "8605c15d-efac-4973-9825-8fa16202c4a4",
    "buildProjectId" : "6a310b95-62e3-48eb-a35b-474f5daa3ccc",
    "buildRecordId" : "48da14e2-6ee7-495b-9dc7-f14d4a344511",
    "devcloudProjectId" : "eeb08ff821434781ac86211e640c50b2",
    "codeciJobId" : "b3c3fbb0cc0a4b388cb500b807a42334",
    "userId" : "6d7a54d45bf44a0684a7a682f719ffd9",
    "buildNo" : 1,
    "dailyBuildNum" : "20220909.1",
    "executionId" : "j_AIQZdVeb",
    "repoName" : "APITest-Python-02",
    "repoId" : 568398,
    "branch" : "master",
    "commit" : "c2be53c0ffe913e4c9b8cebd013dcbef3a76d70b",
    "commitMessage" : "init",
    "commitCreateTime" : "2019-11-13T03:28:32.000+00:00",
    "triggerType" : "MANUAL",
    "buildType" : "branch",
    "status" : "SUCCESS",
    "domainId" : "764f03980afc4e5c97a1a9a73c1d707a",
    "createTime" : "2022-09-09T06:31:50.000+00:00",
    "scheduleTime" : "2022-09-09T06:31:50.000+00:00",
    "queuedTime" : "2022-09-09T06:31:51.000+00:00",
    "startTime" : "2022-09-09T06:31:51.000+00:00",
    "runnableTime" : "2022-09-09T06:31:50.000+00:00",
    "finishTime" : "2022-09-09T06:32:43.000+00:00",
    "duration" : 52261.0,
    "usePrivateSlave" : 0,
    "region" : "xx-xxxx-xx",
    "buildConfigType" : "ACTION\"",
    "tag" : null,
    "recordStatus" : null,
    "errMsg" : 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
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 ShowRecordInfoSolution {

    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();
        ShowRecordInfoRequest request = new ShowRecordInfoRequest();
        request.withJobId("{job_id}");
        request.withBuildNo({build_no});
        try {
            ShowRecordInfoResponse response = client.showRecordInfo(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 = ShowRecordInfoRequest()
        request.job_id = "{job_id}"
        request.build_no = {build_no}
        response = client.show_record_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
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.ShowRecordInfoRequest{}
	request.JobId = "{job_id}"
	request.BuildNo = int32({build_no})
	response, err := client.ShowRecordInfo(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.