Stopping a GitCode Pipeline
Function
This API is used to stop a GitCode pipeline.
Calling Method
For details, see Calling APIs.
URI
POST /v6/{domain_id}/api/pac/pipelines/actions/{pipeline_id}/{pipeline_run_id}/stop
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 |
pipeline_id |
Yes |
String |
Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Constraints: N/A Value range: The value consists of 32 characters, including only digits and letters. Default value: N/A |
pipeline_run_id |
Yes |
String |
Definition: Pipeline run ID. The return value of the API for running a pipeline is the pipeline run ID. Constraints: N/A Value range: The value consists of 32 characters, including only digits and letters. Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
success |
Boolean |
Definition: Whether the calling is successful. Value range:
|
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