• 文档
  • Read Data

Read Data

通过指定通道，使用SQL语句读取数据。

前提条件

已创建数据读取通道，且通道已启动。

请求格式

POST https://{apigw-address}/data-federation/v2.0/channels/read/{channelId}

请求参数（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 的数据格式。目前该字段暂未生效。

响应参数

名称

数据类型

描述

data

List<JSONObject>

通过SQL语句读取到的数据，详见 返回数据结构体

返回数据结构体

名称

数据类型

描述

columns

String

列名。

metadata

String

元数据。

queryState

String

数据查询状态。

rows

List<JSONObject>

数据条目，详见 数据条目结构体

数据条目结构体

名称

数据类型

描述

COLUMN_NAME

String

列名。

DATA_TYPE

String

数据类型。

IS_NULLABLE

String

数据类型。

示例

请求示例

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

method: POST

requestBody:
{
  "sqlQuery": "show schemas"
}

返回示例

{
    "msg": "OK",
    "code": 0,
    "data": {
        "metadata": ["VARCHAR"],
        "columns": ["SCHEMA_NAME"],
        "queryState": "COMPLETED",
        "rows": []
    }
}