Operating a Release Task Based on the Release Task ID
Function
This API is used to release, stop, and continue a release task.
URI
POST /v3/{project_id}/pipeline/pipelines/{pipeline_id}/action
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant's project ID. See Obtaining a Project ID. |
pipeline_id |
Yes |
String |
Release task ID. See Obtaining the Release Task List. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action_id |
Yes |
String |
Action type.
|
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type (format). Default value: application/json;charset=utf8. |
X-Auth-Token |
Yes |
String |
API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
selected_tasks |
No |
List of object |
Task to be executed. When action_id is set to start, if this parameter is not specified or is set to null, all tasks are executed. See Table 5. |
task_name |
No |
String |
Name of the task to be executed. This parameter is mandatory when action_id is set to approval. |
approval_type |
No |
String |
Approval type. This parameter is mandatory when action_id is set to approval, indicating that the application is approved or refused.
|
message |
No |
String |
Approval information. |
Response
Parameter |
Type |
Description |
---|---|---|
id |
String |
Release task execution ID. |
pipeline_id |
String |
Release task ID. |
status |
Integer |
Release task status.
|
Example Request
Start a release task.
{ "selected_tasks": [ { "stage_name": "899tih", "tasks": [ "ujgdh4" ] }, { "stage_name": "uipfzw", "tasks": [ "ax8hus" ] } ] }
Example Response
{ "id": 286541, "pipeline_id": "caf409b1-10df-483a-b14d-7b05f7e12c88", "status": 4 }
Status Code
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
Error Code
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