Cancel Flow Instance¶
终止指定任务流实例的运行。
前提条件¶
用户必须为任务流实例的负责人
用户和任务流都没有被锁定
请求格式¶
POST https://{apigw-address}/dataflow-batch-service/v2.0/flowInstances
请求参数（URI）¶
名称 |
位置（Path/Query） |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|---|
userId |
Query |
必需 |
String |
用户ID。如何获取userId信息>> |
orgId |
Query |
必需 |
String |
用户所属的组织ID。如何获取orgId信息>> |
action |
Query |
必需 |
String |
固定值：cancel |
请求参数（Body）¶
名称 |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|
flowInstId |
必需 |
String |
任务流实例ID。 |
响应参数¶
名称 |
数据类型 |
描述 |
|---|---|---|
data |
String |
运行成功返回空字符串。 |
错误码¶
参见 通用错误码。
示例¶
请求示例¶
url: https://{apigw-address}/dataflow-batch-service/v2.0/flowInstances?action=cancel&userId={}&orgId={}
method: POST
requestBody:
{
"flowInstId":"2438-201908081020"
}
返回示例¶
{
"status":0,
"msg":" Success",
"data":""
}