List Channels¶

查询应用有权使用的数据读取通道、数据写入通道和数据下载通道。

请求格式¶

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

请求参数（URI）¶

名称

位置（Path/Query）

必需/可选

数据类型

描述

orgId

Query

必需

String

应用所属的 OU ID。如何获取 orgId 信息 >>

channelType

Query

可选

String

通道类型，支持以下值：

READ：读通道，从数据源读取数据。
WRITE：写通道，将数据写入数据源。
DOWNLOAD：下载通道，将数据源中的数据下载为文件。

若不指定该参数，则默认查询应用有权使用的所有通道。

响应参数¶

名称	数据类型	描述
channelType	String	通道类型： `READ`：读通道 `WRITE`：写通道 `DOWNLOAD`：下载通道
channelResource	JSON Object	通道所使用资源详情。ChannelResource 结构体 >>
channelUsage	String	通道用途： `TEST`：该通道仅用于测试。 `PRODUCT`：该通道用于正式生产。
channelName	String	通道名称。
channelStatus	String	通道状态，目前仅支持 `START` （运行中）。
channelId	String	通道 ID。
dataSourceInfo	List<JSON Object>	通道已绑定的数据源列表。DataSourceInfo 结构体 >>

ChannelResource 结构体¶

名称	数据类型	描述
resourceId	String	资源池 ID。
resourceConfig	String	资源用量。
ifMultiSourceAnalysis	Boolean	是否为跨源通道。

DataSourceInfo 结构体¶

名称	数据类型	描述
dataSourceName	String	数据源名称。
dataSourceType	String	数据源类型，目前仅支持 `hive_enos`。
alias	String	数据源别名。

示例¶

请求示例¶

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

返回示例¶

{
  "msg": "OK",
  "code": 0,
  "data": [
    {
      "channelId": "yourchannelId",
      "channelName": "yourchannelName",
      "channelType": "WRITE",
      "channelUsage": "TEST",
      "channelStatus": "START",
      "dataSourceInfo": [
        {
          "dataSourceName": "hive_enos",
          "dataSourceType": "hive_enos",
          "alias": "hive_enos"
        }
      ],
      "channelResource": {
        "resourceId": "yourresourceId",
        "resourceConfig": "2cu",
        "ifMultiSourceAnalysis": false
      }
    }
  ]
}