Updated on 2025-09-08 GMT+08:00

Running a YAML Pipeline

Function

This API is used to run a YAML pipeline.

Calling Method

For details, see Calling APIs.

URI

POST /v6/{domain_id}/api/pac/pipelines/{pipeline_id}/run

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Tenant ID.

pipeline_id

Yes

String

Pipeline ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Project ID.

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

sources

No

Array of sources objects

Code repository details.

description

No

String

Running description.

variables

No

Array of variables objects

Parameter list.

choose_jobs

No

Array of strings

Selected tasks to run.

choose_stages

No

Array of strings

Selected stages to run.

Table 4 sources

Parameter

Mandatory

Type

Description

type

No

String

Code source type.

params

No

params object

Parameter details.

Table 5 params

Parameter

Mandatory

Type

Description

git_url

No

String

Code repository address.

git_type

No

String

Code repository type.

ssh_git_url

No

String

SSH address of the code repository.

web_url

No

String

Redirection URL.

repo_name

No

String

Code repository name.

codehub_id

No

String

Code repository ID.

default_branch

No

String

Default branch.

alias

No

String

Code repository alias.

endpoint_id

No

String

Endpoint ID.

build_params

No

build_params object

Trigger parameter details.

change_request_ids

No

String

Request ID.

Table 6 build_params

Parameter

Mandatory

Type

Description

build_type

No

String

Build type.

action

No

String

Job name.

commit_id

No

String

Commit ID.

event_type

No

String

Trigger mode.

merge_id

No

String

merge_id of an MR.

source_branch

No

String

Source branch.

message

No

String

Trigger information.

tag

No

String

Trigger tag.

target_branch

No

String

Target branch.

codehub_id

No

String

Code repository ID.

Table 7 variables

Parameter

Mandatory

Type

Description

name

No

String

Parameter name.

value

No

String

Parameter value.

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

pipeline_run_id

String

Definition:

Pipeline run ID.

Value range:

The value consists of 32 characters, including only digits and letters.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.