根据发布单ID操作发布单
功能介绍
此API用来对发布单进行发布、停止、继续等操作。
URI
POST /v3/{project_id}/pipeline/pipelines/{pipeline_id}/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID。获取方法,请参考获取项目ID。 |
pipeline_id |
是 |
String |
发布单ID。获取方法,请参考获取发布单列表。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action_id |
是 |
String |
操作类型。
|
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json;charset=utf8”。 |
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
selected_tasks |
否 |
List of object |
需要执行的任务,当“action_id”为“start”时需要但是非必传,若不传或传null表示全部执行,请参考表5。 |
task_name |
否 |
String |
需要执行的任务名称,当“action_id”为“approval”时必传。 |
approval_type |
否 |
String |
审批类型,当“action_id”为“approval”时必传,表示审批同意或者拒绝。
|
message |
否 |
String |
审批信息,当“action_id”为“approval”时需要但是非必传。 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
发布单执行ID。 |
pipeline_id |
String |
发布单ID。 |
status |
Integer |
发布单状态。
|
请求示例
启动发布单。
{ "selected_tasks": [ { "stage_name": "899tih", "tasks": [ "ujgdh4" ] }, { "stage_name": "uipfzw", "tasks": [ "ax8hus" ] } ] }
响应示例
{ "id": 286541, "pipeline_id": "caf409b1-10df-483a-b14d-7b05f7e12c88", "status": 4 }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
错误的请求。 |
404 |
请求对象不存在。 |
500 |
内部错误。 |
错误码
请参考ServiceStage错误码。