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":""
}

Java SDK调用示例¶

import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envision.apim.poseidon.request.PoseidonRequest;
import org.junit.Test;

import java.util.HashMap;
import java.util.Map;

public class SampleCode{
    public static class Request extends PoseidonRequest {
        public void setQueryParam(String key, Object value){
            queryParams().put(key, value);
        }
        public void setHeaderParam(String key, String value){
            headerParams().put(key, value);
        }
        public void setBodyParam(Map<String, Object> bodyPara){
            bodyParams().putAll(bodyPara);
        }
        public void setMethod(String method) {
            this.method = method;
        }
        private String method;
        public String baseUri() {
            return "";
        }
        public String method() {
            return method;
        }
    }

    @Test
    public void cancelFlowInstanceTest(){
        //1.在EnOS Console的左边导航栏中点击应用注册。
        //2.点击需调用API的应用，查看基本信息中的AccessKey即为accessKey、SecretKey即为secretKey
        String accessKey = "AccessKey of your APP";
        String secretKey = "SecretKey of your APP";

        //新建一个request 然后把需要的参数传进去存在Query的map中，key是参数名字，value是参数值
        Request request = new Request();
        Map<String,Object> map = new HashMap<>(1);
        map.put("flowInstId","2924-20190812013400");
        request.setBodyParam(map);
        request.setMethod("POST");

        try {
            JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
                    .url("https://{apigw-address}/dataflow-batch-service/v2.0/flowInstances")
                    .queryParam("orgId", "yourOrgId")
                    .queryParam("userId", "yourUserId")
                    .queryParam("action", "cancel")
                    .getResponse(request, JSONObject.class);

            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}