List Pipelines¶

按分页方式获取组织内所有流数据处理任务。

前提条件¶

已通过流数据处理服务创建流数据处理任务。

请求格式¶

GET https://{apigw-address}/streaming/v2.0/streaming/pipelines

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	用户所属的组织ID。如何获取orgId信息>>
pageSize	Query	可选	Integer	查询分页的大小，默认值为10。
pageNo	Query	可选	Integer	当前分页的编号，默认值为1。
isSystem	Query	可选	Boolean	是否查询系统流任务。true：查询系统任务；false：不查询系统任务；默认为false。
ifReleased	Query	可选	Boolean	指定查询已发布或未发布的流数据处理任务。true：查询已发布的任务；false：查询未发布的任务（仍处于设计状态的任务）；默认为false。

响应参数¶

名称	数据类型	描述
data	List<JSONObject>	返回流数据处理任务列表和任务数量。详见 data

data¶

名称	数据类型	描述
count	Integer	返回的流数据处理任务数量。
pipelines	List<JSONObject>	流数据处理任务详细信息。详见 pipelines

pipelines¶

名称	数据类型	描述
orgId	String	用户所属的组织ID。
status	String	流数据处理任务的状态，可返回的状态值包括：PUBLISHED，RUNNING，PAUSED，STOPPED。
version	String	流数据处理任务使用的模板版本。
pipelineId	String	流数据处理任务ID。
pipelineName	String	流数据处理任务名称。
updateTime	String	流数据处理任务更新时间。
alarmConfig	String	流数据处理任务的告警配置，例如：`{\"alarmMode\":1,\"receivers\":\"u15453595541281\"}`。
templateType	Integer	流数据处理任务使用的模板类型。1：原生模板；0：时间窗口聚合模板；2：多路归并模板；3：电量计算模板（按表读数）；4：电量计算模板（按平均功率）；5：电量计算模板（按瞬时功率）。
executionMode	Integer	流数据处理任务的运行模式。0：Standalone模式；1：集群模式。
resourceConfig	String	流数据处理任务的运行资源配置，例如：`{\"men\":2.0,\"cpu\":1.0}`。
messageChannel	Integer	流数据处理任务的消息通道模式。0：实时通道；1：离线通道。

错误码¶

代码	错误信息	描述
61115	Failed to get stream processing jobs.	获取流数据处理任务失败。
61176	Param must be positive.	参数值不能为负值。
99000	Internal Server Error.	服务内部错。

示例¶

请求示例¶

url: https://{apigw-address}/streaming/v2.0/pipelines?orgId=yourOrgId&pageSize=1&pageNo=2&isSystem=false&ifReleased=true

method: GET

返回示例¶

{
    "msg": "OK",
    "code": 0,
    "data": {
        "pipelines": [{
            "templateType": 1,
            "pipelineName": "extended_point",
            "alarmConfig": "{\"alarmMode\":0,\"receivers\":\"u15547747531551\"}",
            "resourceConfig": "{\"men\":2.0,\"cpu\":1.0}",
            "executionMode": 0,
            "updateTime": "2020-10-28 20:41:01",
            "version": "EDH Streaming Calculator Library 0.1.0",
            "messageChannel": 0,
            "orgId": "o15520323695671",
            "pipelineId": "64740da0-747c-4954-a098-981371e70724",
            "status": "RUNNING"
        }, {
            "templateType": 1,
            "pipelineName": "stream-bat",
            "alarmConfig": "{\"alarmMode\":0,\"receivers\":\"u15880500345361\"}",
            "resourceConfig": "{\"cpu\":0.5,\"men\":1.0}",
            "executionMode": 0,
            "updateTime": "2020-10-01 00:32:32",
            "version": "EDH Streaming Calculator Library 0.2.0",
            "messageChannel": 0,
            "orgId": "o15520323695671",
            "pipelineId": "a4e235fb-b183-405c-9329-6e41bd93e65d",
            "status": "STOPPED"
        }],
        "count": 2
    }
}

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.Before;
import org.junit.Test;

public class Sample {
    private static final String API_Gateway_URL = "https://{domain_url}";
    private Poseidon poseidon;

    private static class Request extends PoseidonRequest {

        public void setBodyParams(String key, Object value) {
            bodyParams().put(key, value);
        }

        public void setMethod(String method) {
            this.method = method;
        }

        private String method;

        @Override
        public String baseUri() {
            return "";
        }

        @Override
        public String method() {
            return method;
        }
    }

    @Before
    public void init() {
        poseidon = Poseidon.config(
                PConfig.init()
                        .appKey("AccessKey of your APP")
                        .appSecret("SecretKey of your APP")
        ).method("GET");
    }

    @Test
    public void ListPipelines() {
        Request request = new Request();

        JSONObject response = poseidon
                .url(API_Gateway_URL + "/streaming/v2.0/streaming/pipelines")
                .queryParam("orgId", "yourOrgId")
                .queryParam("pageSize", "5")
                .queryParam("ifReleased", "true")
                .getResponse(request, JSONObject.class);
        System.out.println(response);
    }
}