向导模式配置参数
具有列式存储特性的HBase数据表在配置参数时与其他数据表存在差异,用户可直接查看HBase数据表。
一般数据表
来自关系型数据库的数据表配置API在流程上相同,共有以下步骤。
步骤一:数据源配置
用户需要选择读取的数据库类型、数据源和数据表。

通过数据预览可查看当前选中数据表的字段和数据,便于快速排查选择的数据表是否正确。
步骤二:输入参数与输出参数配置
向导模式中,用户点击“新增参数”以增加当前生成API的输入/输出参数。

用户可对输入/输出参数的基本属性进行配置,输入/输出参数中不能重复添加同一字段。

-
参数名称:绑定字段的映射字段,即调用API时用户实际看到的输入参数名称。
-
操作符:一般为逻辑判断符,在API调用时判断与输入值的逻辑关系后确定调用的数据。
示例:选定“=”操作符,后调用时该字段的输入值为5,则表示调用该字段等于5的数据。 -
必填:确定当前字段是否为必填项。
示例:勾选“必填项”,用户在调用API时必须对该字段有相应输入。 -
行级权限:在API调用时对字段进行访问权限的控制。用户勾选行级权限后,可继续选择“行级权限标识”对字段进行对应权限的控制,若当前没有合适的“行级权限标识”,可前往“API管理-授权与安全-行级权限”进行配置。

以“区域”权限标识为例,当前该标识与用户、cfg_district数据表中的abname字段关联,该标识可控制关联用户在调用API时对abname入参的访问权限仅为“京、津”,无其他区域的访问权限。详情可见行级权限。
步骤三:选择高级配置
用户可对输出结果的形式进行设置,目前支持如下形式:
-
支持分页查询:若选择分页查询,则输出结果分页展示,每页最大返回结果为1000条数据。当输出结果大于1000条数据时,系统强制分页。
-
反馈结果携带分页参数:勾选此选项,用户可查看其他的数据参数。

currentPage:当前页码 + totalPage:总页数 + totalCount:总记录数,如共258条 + pageSize:每页记录数,如20条/页 +
-
返回结果中携带Request Header 参数:勾选此选项,用户可在输出结果中获取request header参数如下:

HBase数据表
HBase数据表由于列存储等特性,在配置API参数时与其他数据表有所不同。
步骤一:数据源配置
用户需要选择读取的数据库类型、数据源和数据表,通过数据预览可查看当前选中数据表的字段和数据,便于快速排查选择的数据表是否正确。
-
字段预览:遍历前50行数据,显示所有的列簇和列,该数据预览仅供参考,以实际数据库中的数据为准。
-
数据预览:遍历前50行数据,部分数据为空表示该行无对应列簇/列。

步骤二:输入参数与输出参数配置
用户点击“新增参数”后左框中显示的字段为遍历前50行数据获得的列簇和列。
-
手动添加其他参数:此处用于添加HBase元数据未获取到的字段,名称须与数据库完全匹配,列按照“列簇:列"的格式填写
-
操作符:HBase的操作符与其他数据源不同,使用需注意。
-
Startrow:从输入的rowkey开始查找(包含输入)
-
Endrow:查找到输入的rowkey之前停止(不包含输入)
-
scan 'scores', {COLUMN=>'course:english',STARTROW=>'Jim',ENDROW=>'Tom'}
说明从‘Jim’开始查找,直到查找到‘Tom’前一行
HBase数据源不支持行级权限的配置。 |
步骤三:选择高级配置:高级配置仅支持返回结果中携带Request Header参数,参数如下:
"Content-Encoding": web服务器支持的反馈内容压缩编码类型。
"Connection":表示是否需要持久连接。
"User-Agent":请求的用户代理。
"Host":指定请求的服务器的域名和端口号。
"Accept-Encoding":指定浏览器可以支持的web服务器反馈内容压缩编码类型。
"Content-Length": 请求的内容长度。
"Content-Type": "请求的与实体对应的MIME信息。