Read Data¶
通过指定通道,使用SQL语句读取数据。
前提条件¶
已创建数据读取通道,且通道已启动。
请求格式¶
POST https://{apigw-address}/data-federation/v2.0/channels/read/{channelId}
请求参数(Header)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
Content-Type | 必需 | String | 内容或文件类型,默认值为 application/json。 |
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 用户所属的组织ID。如何获取orgId信息>> |
channelId | Path | 必需 | String | 通道ID。 |
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
sqlQuery | 必需 | String | 数据查询SQL语句。 |
source | 可选 | String | 在非跨源通道中,指定查询数据源别名。 |
queue | 可选 | String | 指定数据查询任务的优先级,可选项为:Hot,Warm,Cold。Hot 队列为最高优先级,Warm 队列为中优先级,Cold 队列为最低优先级。 |
itemFormat | 可选 | String | 预留字段,指定返回 JSON 的数据格式。目前该字段暂未生效。 |