Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Retrying a Pipeline
Updated on 2024-07-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Retrying a Pipeline

Function

This API is used to retry a pipeline.

Calling Method

For details, see Calling APIs.

URI

PUT /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/retry

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

pipeline_id

Yes

String

Pipeline ID.

pipeline_run_id

Yes

String

Pipeline run ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success

Boolean

Whether the operation is successful.

Example Requests

PUT https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipelines/8bfbd69eac154a0da341705a36294aca/pipeline-runs/94511c7207474053ab5f6e2dd5624cd5/retry

Example Responses

Status code: 200

OK

{
  "success" : true
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent Topic: Pipeline Management