对指定的流水线进行操作
功能介绍
此API用于对指定的流水线进行操作。
URI
POST /cpepipeline/v2/pipelines/{pipeline_id}/action
参数说明见。
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pipeline_id |
是 |
String |
流水线ID。获取方法,请参考查询流水线列表。 |
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json;charset=utf8”。 |
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
actionId |
是 |
String |
操作类型,支持 :
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
流水线名称。 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
执行ID。 |
pipelineId |
String |
流水线ID。 |
status |
Integer |
流水线状态。 |
version |
Integer |
流水线版本。 |
请求示例
启动流水线,调用接口的uri为/cpepipeline/v2/pipelines/c4f1a0cb-49d7-4e62-b4d0-a922f638c867/action?actionId=start
{ "name": "vvasd" }
响应示例
{ "id": 288508, "pipelineId": "c4f1a0cb-49d7-4e62-b4d0-a922f638c867", "version": 0, "status": 4 }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
错误的请求。 |
404 |
请求对象不存在。 |
500 |
内部错误。 |
错误码
请参考ServiceStage错误码。