• 文档
  • List Channels

List Channels

查询已授权给应用的数据读取通道和数据写入通道。

前提条件

用户必须为EnOS用户。

请求格式

GET https://{apigw-address}/data-federation/v2.0/channels

请求参数（URI）

名称

位置（Path/Query）

必需/可选

数据类型

描述

orgId

Query

必需

String

用户所属的组织ID。如何获取orgId信息>>

channelType

Query

可选

String

通道类型，可选项：READ、WRITE；READ 代表读通道，WRITE 代表写通道；如不指定，则表示查询已授权应用的所有通道。

响应参数

名称

数据类型

描述

data

List<JSONObject>

通道信息列表，详见 通道信息结构体

通道信息结构体

名称

数据类型

描述

channelType

String

通道类型，READ（读通道）或 WRITE（写通道）。

channelId

String

通道ID。

channelName

String

通道名称。

channelStatus

String

通道状态，STARTING（启动中）；START（运行中）；STOPING（停止中）；STOP（已停止）；ERROR（错误）。

dataSourceInfo

List<JSONObject>

通道已绑定的数据源列表，详见 数据源信息结构体

channelResource

List<JSONObject>

通道资源配置信息，详见 资源配置信息结构体

数据源信息结构体

名称

数据类型

描述

dataSourceName

String

数据源名称。

dataSourceType

String

数据源类型。

alias

String

数据源别名。

extra

List<JSONObject>

额外信息，包含了执行队列的名称。详见 额外信息结构体

数据源信息结构体

名称

数据类型

描述

reourceId

String

资源ID。

resourceConfig

String

资源配置数量。

ifMultiSourceAnalysis

Boolean

是否开通跨源分析。
额外信息结构体

名称

数据类型

描述

queue

String

执行队列名称。

示例

请求示例

url: https://{apigw-address}/data-federation/v2.0/channels?orgId={}&channelType={}

method: GET

返回示例

{
  "msg": "OK",
  "code": 0,
  "data": [
    {
      "channelId": "",
      "channelName": "",
      "channelType": "WRITE",
      "channelStatus": "STOP",
      "dataSourceInfo": [
        {
          "alias": "",
          "extra": {
            "queue": "root.edp_data_federation"
          },
          "dataSourceName": "",
          "dataSourceType": ""
        }
      ],
      "channelResource": {
        "resourceId": "",
        "resourceConfig": "2cu",
        "ifMultiSourceAnalysis": false
      }
    }
  ]
}

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 com.google.common.net.HttpHeaders;
import org.apache.commons.codec.binary.Hex;
import org.junit.Test;

import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

public class Sample {

    private static String accessKey = "AccessKey of your APP";
    private static String secretKey = "SecretKey of your APP";
    private static String orgId = "yourOrgId";
    private static String url = "https://{domain_url}";

    private static class Request extends PoseidonRequest {

        public void setQueryParam(String key, Object value) {
            queryEncodeParams().put(key, value);
        }

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

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

        private String method;

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

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

    @Test
    public void listChannels() {
        Request request = new Request();
        request.setQueryParam("orgId", orgId);
        request.setMethod("GET");
        request.headerParams().put(HttpHeaders.CONTENT_TYPE, "application/json");
        try {
            JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
                    .url(url + "/data-federation/v2.0/channels")
                    .getResponse(request, JSONObject.class);
            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}