Help Center/ ServiceStage/ API Reference/ Historical APIs/ Build APIs/ Obtaining Build Logs Based on the Build Job Instance ID

Updated on 2024-12-16 GMT+08:00

View PDF

Obtaining Build Logs Based on the Build Job Instance ID

Function

This API is used to obtain build job logs based on the build job instance ID.

URI

GET /assembling/v1/builds/{build_id}/logs?from={from}

Table 1 describes the parameters.

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
build_id	Yes	String	Build job instance ID. See Obtaining the Build Job Instance List Based on the Build Job ID.
from	Yes	Integer	Start position for obtaining logs, for example, 0.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Response

**Table 3** Response parameters
Parameter	Type	Description
buildlog	String	Returned build log.
next	Integer	End position of the returned log string.
phase_states	String	Build phase status. NotStarted Queuing Building Pushing: The package is being pushed. Successful Failed Timeout Cancel Deleted
phases	String	Build phase name. Init Download PreProcess Build Artifact PostProcess

Example Request

None

Example Response

{
    "buildlog": "Starting...",
    "next": 25524,
    "phase_states": "Successful,Successful,Successful,Successful,Successful,Successful",
    "phases": "Init,Download,PreProcess,Build,Artifact,PostProcess"
}