• 文档
  • 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、DOWNLOAD；READ 代表读通道，WRITE 代表写通道，DOWNLOAD 代表下载通道；如不指定，则表示查询已授权应用的所有通道。

响应参数

名称

数据类型

描述

data

List<JSONObject>

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

通道信息结构体

名称

数据类型

描述

channelType

String

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

channelResource

JSONObject

通道所使用资源详情，详见 资源信息结构体

channelUsage

String

通道用途，TEST（测试通道）,PRODUCT（生产通道）

channelName

String

通道名称

channelStatus

String

通道状态，START（运行中），STARTING（启动中），STOP（已停止），STOPING（已停止），ERROR（异常）

channelId

String

通道ID。

dataSourceInfo

List<JSONObject>

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

数据源信息结构体

名称

数据类型

描述

dataSourceName

String

数据源名称。

dataSourceType

String

数据源类型。

alias

String

数据源别名

资源信息结构体

名称

数据类型

描述

resourceId

String

使用资源池ID。

resourceConfig

String

资源用量。

ifMultiSourceAnalysis

Boolean

是否为跨源通道

示例

请求示例

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

method: GET

返回示例

{
  "msg": "OK",
  "code": 0,
  "data": [
    {
      "channelId": "ch-123456",
      "channelType": "WRITE",
      "dataSourceInfo": [
        {
          "dataSourceName": "mysql",
          "dataSourceType": "MYSQL"
        }
      ]
    }
  ]
}