数据服务功能是将数据服务化,通过接口将数据库中的数据提供给上层应用。该功能仅适用于专业版。
操作步骤
您可以通过以下方式进行数据服务功能设置:
登录Quick BI控制台。
在Quick BI产品首页,按照下图指引,新建API。
在新建API的配置基础信息页面,输入API名称、接口工作空间、接口数据集、数据返回类型、API描述等参数并单击下一步,下图所示。
在新建API的添加API参数页面,设置请求参数和返回参数,并单击保存或者保存并调试,如下图所示。
说明保存可保存当前设置,保存并调试可跳转至调试API页面。
单击保存并调试进入调试API页面,输入调试参数值并选择返回参数。
单击运行调试,在调试结果中可查看返回JSON和数据预览,如下图所示。
说明通过数据服务功能创建的API接口存在以下调用权限限制:调用API接口的阿里云账户,需被授予Quick BI组织管理员及权限管理员的权限,且至少登录过一次Quick BI,才支持调用API接口。
相关操作
完成接口创建后,您可以通过数据服务模块查看已创建API接口的ID、名称、所属数据集、所属工作空间等信息,不同页签下所显示的API接口及可进行的操作不同。
我的 页签下展示了当前用户创建的所有API接口及其相关信息,同时此页面支持进行以下操作。
查看
点击API ID旁的图标,即可于右侧弹窗中查看该API的基本信息、请求参数与返回参数。您也可以在该弹窗中对当前API进行修改、调试、删除、转让。
编辑
点击操作列图标,跳转至编辑API页面,按需修改当前API的基础信息、参数信息,完成后点击保存/保存并测试。
调试
点击操作列图标,跳转至调试API页面,维护相关参数信息并点击运行调试。
统计
点击操作列图标,跳转至API调用统计 > 详情页面,查看当前API接口的各项调用数据。关于API调用统计的详细说明,请参见API调用统计。
转让
点击操作列图标,在转让API > 创建人中选择需要接收当前API创建角色的用户,点击确定完成转让。
说明创建人角色默认具有当前API的调用及管理权限。
删除
点击操作列图标,在确认弹窗中点击确定,即可删除当前API。
全部 页签下展示了当前租户创建的所有API接口及其相关信息。
对于当前用户创建的API接口:您可以在此查看您创建的API接口详情并进行管理,具体操作说明同我的所述。
对于非当前用户创建的API接口:仅支持查看API接口详情,相关管理操作入口无权限进入。