Obtaining Pipeline Statuses in Batches

Function

This API is used to obtain pipeline statuses and stage information.

Calling Method

For details, see Calling APIs.

URI

GET /v3/pipelines/status

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
pipeline_ids	Yes	String	ID of the pipeline whose status is to be obtained. IDs are separated by commas (,).

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for .

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of PipelineExecuteStates objects	Pipeline execution result.

**Table 4** PipelineExecuteStates
Parameter	Type	Description
result	String	Pipeline execution result. The value can be success, error, or aborted.
status	String	Definition: Pipeline execution status. Constraints: N/A Range: waiting: The pipeline is waiting to begin. running: The pipeline is running. verifying: This pipeline is to be reviewed. suspending: The pipeline is suspended. completed: The execution is completed. Default value: N/A
stages	Array of Stages objects	Stage execution status.
executor	String	Executor.
pipeline_name	String	Pipeline name.
pipeline_id	String	Pipeline ID.
build_id	String	Pipeline execution ID.
detail_url	String	URL of the pipeline details page.
modify_url	String	URL of the pipeline editing page.
start_time	String	Execution start time.
end_time	String	Execution end time.

**Table 5** Stages
Parameter	Type	Description
result	String	Execution result of a stage. The value can be success, error, or aborted.
status	String	Stage execution status. The value can be waiting, running, verifying, suspending, or completed.
name	String	Stage name.
parameters	Object	Stage running parameters.
order	Integer	Stage sequence.
dsl_method	String	Stage type.
display_name	String	Stage display name.

Status code: 400

**Table 6** 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/status?pipeline_ids=8025ba36a87a4dd5af496708c2961817,413937e669914f95bed293617886c6c1

Example Responses

Status code: 200

[ {
  "result" : "error",
  "status" : "completed",
  "stages" : [ {
    "result" : "success",
    "status" : "completed",
    "name" : "initial",
    "parameters" : null,
    "order" : 1,
    "dsl_method" : "initial",
    "display_name" : "Source code"
  }, {
    "result" : "success",
    "status" : "completed",
    "name" : "state_3",
    "parameters" : null,
    "order" : 2,
    "dsl_method" : "build",
    "display_name" : "Build"
  } ],
  "executor" : "executor",
  "pipeline_name" : "Do not delete the PipelineSvc test._Continue the test.",
  "pipeline_id" : "92a65e2337174fabbdbccda97ab7ffad",
  "detail_url" : "https://example.com",
  "modify_url" : "https://example.com",
  "start_time" : "2022-09-09 00:00:00",
  "end_time" : "2022-09-09 00:00:24",
  "build_id" : "25"
} ]