Skip to main content
Version: 2.13.0

使用Swagger UI调用REST API用例

综述​

本页演示使用Swagger UI调用炎凰数据平台Rest API的用例。

登录认证​

获取有效Token​

login 访问Login API， 点击"Try it out"， 在Request body中输入正确的username和password。注意: password需要用base64编码，例如默认密码"changeme", 对应的base64编码为"Y2hhbmdlbWU=" 。可以参考https://www.base64encode.org/{:target="_blank"}来生成相应密码的base64编码。

login_execute 点击"Execute", 正确执行后，可以在返回结果中找到accessToken, 复制内容后，点击右上角"Authorize", 在弹出的对话框 "jwt (http, Bearer) Value:" 处粘贴accessToken，点击Authorize，关闭窗口。 jwt_authorize

更新Token​

后续的API操作会自动引用上述步骤输入的Token来验证，无需重复操作，当超过有效期后，请重新访问Login API获取新的Token或者访问Refresh API， 用登录成功结果中返回的refreshToken来刷新生成一个新的Token。

登出账户​

访问Logout API, 传入登录时拿到的refreshToken来登出账户

数据导入​

创建HEI Endpoint​

在通过API导入数据之前，请先确保相应的HEI Endpoint已经创建可用，请参见 API导入数据

颁发API Token​

请确保需要导入数据的HEI Endpoint中的API Token还在有效期内，如果已过期，设置有效时间范围后点击重新颁发，获得新的API Token。

使用API Token向指定的数据集导入数据​

在正式导入数据之前，可以通过Swagger UI来进行简单的测试，访问 Ingestion Events API, 点击右侧的锁，输入API Token，在Request body中输入以行为单位的多条事件。 具体如何通过脚本或者程序来导入数据，请参见API导入数据

上传文件​

除了通过API导入数据，还可以通过上传文件的方式将文件的内容导入到指定的数据集。访问 Upload File API, 点击右侧的锁，输入Login后获得的Token，注意不是API Token。

upload_file

查询数据​

可以通过查询服务，运行指定的查询语句，通过同步或者异步的方式，得到JSON格式的查询结果集。

创建查询任务​

访问Search Job API - POST，输入查询，指定查询时间范围，提交后返回Job Id。 然后，可以通过Search Job API - GET来查询查询任务的执行状态，也可以通过Search Job Results API来获取查询结果集。

创建即席查询​

如果要即时执行查询，立即得到查询结果，也可以访问Search Command API，API访问会阻塞直到结果返回。

导出查询结果集​

可以将查询任务和即席查询的结果集导出到本地的文件，目前支持的格式为json, csv和html。

Search Job Results Export APISearch Command Results Export API

参数列表​

  • file_type: 导出结果集的数据类型格式，目前支持json, csv和html

  • file_name: 导出结果集的目标文件名

  • filtered_fields[可选]: 导出结果集的时候可以指定需要过滤的字段，以逗号分隔，例如 field1,field2,field3

  • limit[可选]: 导出结果集的条数，默认从第一条开始。不填或者填0，意味着全部结果集。

  • offset[Search Job可选]: 导出结果集起始位置，可以和limit结合达到翻页导出的效果。