Running a GitCode Pipeline
Function
This API is used to run a GitCode pipeline.
Calling Method
For details, see Calling APIs.
URI
POST /v6/{domain_id}/api/pac/pipelines/actions/run
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Definition: Tenant ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
https_url |
No |
String |
Definition: Trigger URL. Constraints: N/A Value range: N/A Default value: N/A |
file_path |
No |
String |
Definition: File storage path. Constraints: N/A Value range: N/A Default value: N/A |
file_content |
No |
String |
Definition: File details. Constraints: N/A Value range: N/A Default value: N/A |
branch |
No |
String |
Definition: Name of the code source branch. Constraints: N/A Value range: N/A Default value: N/A |
encoding |
No |
String |
Definition: File encoding mode. Constraints: N/A Value range: N/A Default value: N/A |
tag |
No |
String |
Definition: Code source tag. Constraints: N/A Value range: N/A Default value: N/A |
commit_id |
No |
String |
Definition: Commit ID in code source. Constraints: N/A Value range: The value contains 40 characters. Default value: N/A |
access_token |
No |
String |
Definition: Token for accessing the code source. Constraints: N/A Value range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
pipeline_id |
String |
Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Value range: The value consists of 32 characters, including only digits and letters. |
pipeline_run_id |
String |
Definition: Pipeline run ID. The return value of the API for running a pipeline is the 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