Obtaining the Pipeline Execution Status in a Project

Function

This API is used to obtain the pipeline execution status in a project.

Calling Method

For details, see Calling APIs.

URI

GET /v3/pipelines/build-result

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
start_date	Yes	String	Definition: Start date. Constraints: The interval between the start date and end date cannot exceed one month. The start date is included. Value range: N/A Default value: N/A
end_date	Yes	String	Definition: Start date. Constraints: The interval between the start date and end date cannot exceed one month. The start date is included. Value range: N/A Default value: N/A
offset	Yes	Integer	Definition: Offset where the query starts. Constraints: N/A Value range: The value is no less than 0. Default value: N/A
limit	Yes	Integer	Definition: Number of records of each query. Constraints: N/A Value range: The value is no less than 0. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
offset	Integer	Definition: Offset where the query starts. Value range: The offset value must be no less than 0.
limit	Integer	Definition: Number of records of each query. Value range: The value is no less than 0.
total	Integer	Definition: Total number of items. Value range: N/A
build_results	Array of PipelineBuildResult objects	Definition: Execution status list. Value range: N/A

**Table 4** PipelineBuildResult
Parameter	Type	Description
build_id	String	Definition: Pipeline execution ID. Value range: N/A
elapse_time	String	Definition: Running duration, in milliseconds. Value range: N/A
end_time	String	Definition: Execution end time. Value range: N/A
outcome	String	Definition: Running result. Value range: success: The execution is successful. error: The execution failed. aborted: The execution is aborted.
pipeline_id	String	Definition: Pipeline ID. Value range: The value consists of 32 characters, including digits and letters.
pipeline_name	String	Definition: Pipeline name. Value range: N/A
start_time	String	Definition: Execution start time. Value range: N/A
status	String	Definition: Running status. Value range: waiting: The pipeline is waiting to begin. running: The pipeline is being executed. verifying: This pipeline is to be reviewed. suspending: The pipeline is suspended. completed: The execution is completed.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

GET https://{endpoint}/v3/pipelines/build-result?project_id=8025ba36a87a4885af496708c2961817&start_date=2020-07-01&end_date=2020-07-31&offset=0&limit=10

Example Responses

Status code: 200

{
  "offset" : 0,
  "limit" : 10,
  "total" : 29,
  "build_results" : [ {
    "status" : "completed",
    "outcome" : "success",
    "pipeline_id" : "fbe06e5655764f049f4d988bd2941279",
    "pipeline_name" : "API test pipeline_YN96I241",
    "build_id" : "12",
    "start_time" : "2021-08-10 00:00:01",
    "end_time" : "2021-08-10 00:00:02",
    "elapse_time" : "917"
  } ]
}