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

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

View PDF

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

Function

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

URI

GET /assembling/v1/builds/{build_id}/phases

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.

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.

**Table 4** list
Parameter	Type	Description
id	String	Build phase ID.
name	String	Build phase name. Init Download PreProcess Build Artifact PostProcess
state	String	Build phase status. NotStarted Queuing Building Pushing: The package is being pushed. Successful Failed Timeout Cancel Deleted

Example Request

None

Example Response

{
    "total": 6,
    "list": [
        {
            "id": 1627984,
            "name": "Init",
            "state": "Successful"
        },
        {
            "id": 1627985,
            "name": "Download",
            "state": "Successful"
        },
        {
            "id": 1627986,
            "name": "PreProcess",
            "state": "Successful"
        },
        {
            "id": 1627987,
            "name": "Build",
            "state": "Successful"
        },
        {
            "id": 1627988,
            "name": "Artifact",
            "state": "Successful"
        },
        {
            "id": 1627989,
            "name": "PostProcess",
            "state": "Successful"
        }
    ]
}