海纳嗨数-帮助中心
原始数据导出API
一、原始数据导出API
为支持客户进行数据查询以及数据的二次开发,支撑更广泛的数据应用,更好的发挥数据价值
二、调用方法
API URL: https://higateway.haishuu.com/gateway/hi-api/v1/data-export
请求方式:POST Content-Type: application/json
接口状态:正常
2.1 请求参数
| 名称 | 位置 | 类型 | 是否必填 | 描述 |
|---|---|---|---|---|
| hi-api-key | header | String | 是 | 访问接口的权限key【获取hi-api-key】 |
| 字段 | 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|---|
| sql | 查询SQL | String | 是 | 仅支持事件或用户单表查询,例如:select * from dwd_event_demo1 |
| beginDate | 开始日期 | String | 否 | 查询事件表时必填,例如:2024-06-11 |
| endDate | 结束日期 | String | 否 | 查询事件表时必填,例如:2024-06-17 |
2.2 返回参数
| 字段 | 名称 | 类型 | 描述 |
|---|---|---|---|
| status | 接口响应状态码 | Integer | 成功=200 |
| code | 业务响应编码 | String | 成功=0 |
| message | 业务响应描述 | String | 操作成功 |
| success | 接口成功标记 | Boolean | true 成功, false 失败 |
| data | 返回数据 | String | 导出文件的下载地址 |
{
"status": 200,
"code": "0",
"message": "操作成功",
"success": true,
"data": "https://test-minio.hinadt.com/dorisexport/dwd_event_demo5_ae4f64254f7a4a69-862b278a4acd1276_0.csv"
}三、错误码
| 接口响应状态码 | 接口响应状态码描述 | 业务响应编码 | 业务响应编码描述 |
|---|---|---|---|
| 200 | 成功 | 0 | 成功 |
| 5001 | 业务异常 | API_PROCESS_FAIL | 查询引擎发生错误 |
| 5001 | 业务异常 | API_KEY_EXPIRED | API_KEY已过期 |
| 5001 | 业务异常 | NOT_IN_IP_WHITE_LIST | IP白名单限制 |
| 5001 | 业务异常 | API_KEY_NOT_EXISTED | API_KEY不存在 |
| 5001 | 业务异常 | API_PROCESS_FAIL | 查询引擎发生错误 |
| 5001 | 业务异常 | UNSUPPORTED_SQL | 不支持的SQL |
| 5001 | 业务异常 | API_KEY_EXPORT_DATA_DATE_FAIL | 请填写正确的分区日期,分区日期必须在一年内,并且只能导出7天的数据 |
| 5001 | 业务异常 | OPEN_API_REQUEST_LIMIT | 当前Api超过每秒请求次数 |
| 6001 | 参数验证异常 | PARAM_VERIFY_FAIL | 参数验证失败 |
{
"status": 5001,
"code": "NOT_IN_IP_WHITE_LIST",
"message": "IP白名单限制 [172.23.7.64]",
"success": false,
"data": null
}{
"code":"API_PROCESS_FAIL",
"data":null,
"message":"查询引擎发生错误",
"status":5001,
"success":false
}{
"code":"OPEN_API_REQUEST_LIMIT",
"data":null,
"message":"当前Api超过每秒请求次数",
"status":5001,
"success":false
}四、限制
| 类型 | 调用限制 | 描述 |
|---|---|---|
| 租户 | QPS:2次/秒 | 接口限制 |
作者:超级管理员 创建时间:2024-06-19 09:49
最后编辑:超级管理员 更新时间:2025-09-19 16:03
最后编辑:超级管理员 更新时间:2025-09-19 16:03