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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Tenant ID. |
pipeline_id |
Yes |
String |
Pipeline ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
No |
String |
Project ID. |
Request 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
No |
String |
Code source type. |
params |
No |
params object |
Parameter details. |
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. |
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. |
Response Parameters
Status code: 200
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot