提交运行流
功能介绍
根据流id提交流到后台运行。
接口约束
无
URI
POST /v1/{project_id}/flows/{flow_id}/run
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id,用于资源隔离。获取方法请参考获取项目ID。 |
|
flow_id |
是 |
String |
流id。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
run_mode |
是 |
String |
流运行模式,通常有手动、自动、测试这几种。手动方式需要用户在页面点击运行流,自动方式会按照触发器的类型自动运行流,测试方式用户在创建流的时候可以测试流的功能。 |
|
input |
否 |
Map<String,Object> |
流操作输入参数,一般为JSON字符串,可以为空。具体与要执行的流有关。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
running_id |
String |
流记录id。 |
|
flow_id |
String |
流id。 |
|
success |
Boolean |
流运行状态
|
|
flow_name |
String |
流名称。 |
|
message |
String |
返回信息。 |
状态码: 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 最小长度:8 最大长度:36 |
|
error_msg |
String |
错误描述。 最小长度:2 最大长度:512 |
状态码: 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 最小长度:8 最大长度:36 |
|
error_msg |
String |
错误描述。 最小长度:2 最大长度:512 |
请求示例
无
响应示例
状态码: 200
请求成功。
{
"running_id" : "0d16aee0-bdb9-4a1c-851b-87e11ec67322",
"flow_id" : "f113423c-4759-4fe3-95fb-642bb265a2d2",
"success" : true,
"flow_name" : "流9472f",
"message" : ""
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
403 |
权限不足。 |
|
500 |
系统异常。 |
错误码
请参见错误码。