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

Updated on 2024-11-27 GMT+08:00

View PDF

Obtaining the Build Job Instance List Based on the Build Job ID

Function

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

URI

GET /assembling/v1/jobs/{job_id}/builds?name={job_name}

Table 1 describes the parameters.

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
job_id	Yes	String	Build job ID. See Obtaining the Build Job List Based on the Component Name.
job_name	Yes	String	Build job name. See Obtaining the Build Job List Based on the Component Name.

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
list	Array of object	Build phase structure. See Table 4.
total	Integer	Number of build phases.
page	Integer	Start page number.
per_page	Integer	Page size.
finished	Integer	Number of completed build instances.
successful	Integer	Number of successful build instances.

**Table 4** list
Parameter	Type	Description
build_id	String	Build job instance ID.
build_state	String	Build instance status. Cancel Failed Successful Timeout
duration	Integer	Build duration, in seconds.

Example Request

None

Example Response

{
    "total": 1,
    "per_page": 20,
    "page": 1,
    "finished": 1,
    "successful": 1,
    "list": [
        {
            "build_id": "0f7fqckzmjcfi0f7yxhx91l2rwrfyzd2poac90b5",
            "build_state": "Successful",
            "duration": 1181
        }
    ]
}