Help Center/ CodeArts Build/ API Reference/ APIs/ Build Task Management/ Obtaining the Status, Completion Percentage, and Estimated Time Remaining for a Named Build

Updated on 2025-08-21 GMT+08:00

Online Debugging

CLI Examples

View PDF

Obtaining the Status, Completion Percentage, and Estimated Time Remaining for a Named Build

Function

This API is used to obtain the status, completion percentage, and estimated time remaining for a named build.

Calling Method

For details, see Calling APIs.

URI

GET /v1/job/{job_id}/{build_no}/build-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

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
result	Array of result objects	Returned result.
error	String	Returned error message.
status	String	Returned status information.

**Table 3** result
Parameter	Type	Description
building	Boolean	Whether the build is in progress.
build_result	String	Build result.
region	String	region

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

GET https://{endpoint}/v1/job/{job_id}/{build_no}/build-info

Example Responses

Status code: 200

{
  "result" : [ {
    "building" : false,
    "build_result" : "FAILURE",
    "region" : "xx-xxxx-xx"
  } ],
  "error" : null,
  "status" : "success"
}