Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Pipeline Triggering Failure Records

Updated on 2025-03-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Pipeline Triggering Failure Records

Function

This API is used to query pipeline triggering failure records.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/trigger-failed-record

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: CodeArts project ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A.
pipeline_id	Yes	String	Parameter description: Pipeline ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Long	Offset.
limit	Yes	Long	Number of records on each page.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
offset	Integer	Offset.
limit	Integer	Number of records on each page.
total	Integer	Total number.
triggerFailedRecordVOS	Array of triggerFailedRecordVOS objects	Details list.

**Table 4** triggerFailedRecordVOS
Parameter	Type	Description
pipeline_id	String	Pipeline ID.
trigger_time	Integer	Trigger time.
trigger_type	String	Trigger type.
executor_id	String	Executor ID.
executor_name	String	Executor name.
reason	String	Cause of trigger failure.

Example Requests

GET https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/dc73b5ed58a64ab7a469b9480e5f6632/trigger-failed-record?offset=0&limit=10

Example Responses

Status code: 200

Response body.

{
  "offset" : 0,
  "limit" : 10,
  "total" : 3,
  "triggerFailedRecordVOS" : [ {
    "pipeline_id" : "dc73b5ed58a64ab7a469b9480e5f6632",
    "trigger_time" : 1718956712000,
    "trigger_type" : "Push",
    "executor_id" : "123456",
    "executor_name" : "12-5",
    "reason" : "Trigger branch is not whitelisted"
  }, {
    "pipeline_id" : "dc73b5ed58a64ab7a469b9480e5f6632",
    "trigger_time" : 1718956668000,
    "trigger_type" : "Push",
    "executor_id" : "456",
    "executor_name" : "456-5",
    "reason" : "Trigger branch is not whitelisted"
  }, {
    "pipeline_id" : "dc73b5ed58a64ab7a469b9480e5f6632",
    "trigger_time" : 1718956660000,
    "trigger_type" : "Push",
    "executor_id" : "789",
    "executor_name" : "78-5",
    "reason" : "Trigger branch is not whitelisted"
  } ]
}