跳到主要内容
版本：2.14.0

使用Postman调用REST API用例

综述​

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

准备工作​

  • 确保能够使用postman桌面版v7.0以上版本或网页版
  • 下载保存 YH API.postman_collection.json
  • 将下载的YH API.postman_collection.json文件导入postman桌面版或网页版 import
  • 创建postman环境变量，并应用该环境变量
    - 设置炎凰数据平台host变量
    - 设置炎凰数据平台port变量
    create_env

登录认证​

炎凰数据平台遵从JSON Web Token(JWT)规范，基于用户和角色对资源访问进行权限控制。访问API之前需要通过登录验证拿到合法的Token，在成功获取Token之后可以在后续的请求访问中复用，默认的有效期为2小时。

通过运行Get Token请求获取有效Token​

首先在Get Token请求的Body中输入正确的username和password。注意: password需要用base64编码，例如默认密码"changeme", 对应的base64编码为"Y2hhbmdlbWU=" 。可以参考https://www.base64encode.org/{:target="_blank"}来生成相应密码的base64编码。 点击发送请求后，即可成功获取Token。Token将被存储在全局变量中，以供后续请求使用。 get_token

更新Token​

后续的API操作会自动引用上述步骤输入的Token来验证，无需重复操作，当超过有效期后，请执行Refreash Token请求。无论之前的Token是否已过期，发送该请求都将重新获得一个有效期为2小时的Token。 refreash_token

管理数据集​

创建数据集​

执行请求Create Eventset, 将会在炎凰数据平台创建相应的数据集，本例中数据集名字默认设置为"test_event_set",可在Create Eventset请求Body中修改name属性值，自行修改。本例将在最后创建的数据集上进行后续的操作。 create_eventset

获取数据集信息（可选）​

执行请求Get Eventset，将会获取相应数据集的信息。本例中将会获取最近创建的数据集信息。 get_eventset

数据导入​

创建HEI Endpoint​

执行请求Create HEI Endpoint创建相应的HEI Endpoint。本例中HEI Endpoint名字默认设置为"test_endpoint"，目标数据集为前步创建但数据集，可在请求的Body中自行修改。本例将在最后创建的HEI Endpoint上进行后续的操作。 create_HEI

获取HEI Endpoint（可选）​

执行请求Get HEI Endpoint，将会获取相应HEI Endpoint的信息。本例中将会获取最近创建的HEI Endpoint信息。 get_HEI

颁发API Token​

执行请求Generate API Token，将会获取API Token用于数据导入。如果现有API Token过期，可重新发送该请求，获得新的API Token。 generate_api_token

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

执行请求Ingest Events，将会向前步创建的HEI Endpoint发送数据。发送数据内容可在Request body中自行修改，但必须是以行为单位的事件。 ingest_events

上传文件​

修改请求Upload File的body，把example.csv替换成一个本地的csv文件。 然后执行请求Upload File，就会将该csv文件上传至前例中创建的数据集。如果上传csv以外的文件，需要同时修改Params中的相应参数值。 ingest_events

查询数据​

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

创建查询任务​

执行请求Create Search Job，将会创建一个异步但查询，查询内容可在Request body中自行修改。得到jobId返回值将会自动存储为全局变量，供后续请求使用。 create_search

获取查询任务状态​

执行请求Get Search Job Status，将会返回前步查询任务的状态，若返回状态为"Done"，说明查询已经执行完成。 get_search_status

获取查询任务结果​

执行请求Get Search Job Results，将会返回前步已经执行完成的查询任务的结果。 get_search_results

下载查询任务结果​

执行请求Export Search Job Results，将会返回前步已经执行完成的查询任务的结果，并且在postman中可以下载为相应格式的文件。 export_search_results

创建即席查询​

执行请求Ad-hoc Search，将会创建一个同步的查询，API访问会阻塞直至查询执行结束，结果返回。查询内容可在Request body中自行修改。 create_adhoc_search

创建即席查询并下载查询结果​

执行请求Export Ad-hoc Search Results，将会创建一个同步的查询，API访问会阻塞直至查询执行结束，结果返回。并且在postman中可以下载查询结果为相应格式的文件。 export_adhoc_search_results

清理​

删除HEI Endpoint（可选）​

执行请求Delete HEI Endpoint，将会删除最近通过本例创建的HEI Endpoint。删除后将不能再往该HEI Endpoint发送数据，不可恢复。

删除数据集（可选）​

执行请求Delete Eventset，将会删除最近通过本例创建的数据集。删除后，所有该数据集内的数据也将被删除，不可恢复。

登出账户​

执行请求Logout，将会登出用户，所有前步的Token将会失效。如需要继续执行本例请求，需要重新执行Get Token请求。