You need to enable JavaScript to run this app.
导航
8.4.2 数据集API
最近更新时间:2022.09.05 11:25:40首次发布时间:2022.09.05 11:25:40
我的收藏
有用
有用
无用
无用

在创建 API 之前,需要把希望通过接口访问数据导入到数据服务。并且在用户有权限的 API 目录中,添加 API。

向导式API

请根据API最终服务的需求方,创建一个API目录或在已有的 API目录中添加。根据页面提示,点击右上角的【+添加API】触发向导式生成API。
第一步:编辑基本信息。
alt

第二步:选择数据集并设计API。
ElasticSearch/Hana数据集API
alt

HBase数据集API
alt

其中,hbase数据集的“所有字段展示”展示的是hbase表中的所有列簇(column family),具体请求字段及返回字段需要用户在“列名”一栏显示指定。
第三步:测试 API,系统将自动保存正常的API返回内容作为示例文档。
alt

保存API后,可以在API列表对其进行管理。如需在 线上环境调用,需要发布 API。

脚本式API

请根据API最终服务的需求方,创建一个API目录或在已有的 API目录中添加。目前脚本式创建API支持的是动态SQL。
alt

第一步:编辑通用信息。
alt

第二步:选择同数据源的一个或者多个数据集并设计API:先编辑请求和返回参数,再编辑SQL。
注意:ElasticSearch和HBase的API不支持使用多个数据集。
ElasticSearch/Hana数据集API
alt

alt

Hbase数据集API
alt

第三步:测试 API,系统将自动保存正常的API返回内容作为示例文档。
alt

保存API后,可以在API列表对其进行管理。如需在线上环境调用,需要发布 API。

数据集原生API

原生API 是支持用户灵活查询数据集的一种 API,每个数据集仅支持配置一套原生API,无需预先设计API调用模式。调用原生API时通过 Unified SQL 对数据集进行动态查询,并在线返回结果。
第一步 配置原生API
与其他 API添加方式相同,在API目录右上角,点击【添加 API】,即可创建原生API。
alt

创建后,首先选择接口的网络类型,之后选择数据集和需要的API种类(访问功能)。
注意: 新增数据源当前支持且仅支持在线查询类API,即通过dynamic sql灵活查询数据集;
alt

第二步 查看原生API
生成后,你可以在API目录里,查看对应API详情。也可以,从数据集操作中,选择【查看原生API】。
alt

第三步 修改原生API
如同其他的API,点击API操作中的【编辑】即可修改。原生API因为没有设计步骤,因此只能修改基本信息。
alt

发布API

API 创建后,未发布则无法调用。数据服务已经支持用户将 API 发布上线。

  1. 选择需要发布的API,可以根据需求对应的 API目录 快速寻找。
  2. 选定API目录后,可以看到 API列表对其进行管理。如需在线上环境调用,需要发布 API。
    alt

发布到线上环境,则会在API列表展示 线上环境调用地址。
alt