数据服务API是一种API类型,由云计算资源中的数据通过参数配置生成,生成的API便于后续调用,减少资源操作成本。SQL模式创建数据服务API适用于多表关联、复杂筛选过滤的查询,通过编写SQL代码的方式完成API封装。本文介绍如何用SQL模式创建数据API。
前提条件
操作步骤
登录数据资源平台控制台。
在页面左上角,单击图标,选择协同。
在顶部菜单栏,单击图标,选择目标工作组,单击资产加工。
在左侧导航栏,单击图标,选择API开发 > 数据服务API。
在数据服务API页面右上角,单击创建API。
在数据服务API-创建页面,开始创建API。
在基础信息区域,设置API的基础信息。
参数
说明
API名称
API的名称,自定义即可。
所属应用
选择API的归属应用。单击新增应用,可新建应用,更多信息请参见新建应用。
服务协议
选择服务的协议类型。
API Path
API调用时展示的固定路径,默认自动生成。
调用认证方式
简单身份认证和加密身份认证两种方式,更多信息,请参见认证方式说明。
简单身份认证:适用于工作组内、测试等场景下的API调用,工作组内调用时用API归属应用的AppCode调用。
加密身份认证:通过加密算法计算一个签名并放在请求的Header中即可调用API,具备更高的安全性,适用于API共享后,应用开发场景下API的调用。
标签
添加API的应用模块标签,可选项,便于后续统计分析。
添加方式:单击加号,在添加标签对话框,选择应用及模块标签,单击确认。
描述
自定义API的描述信息,必填。
在参数配置区域,配置API参数。
参数
说明
云计算资源
选择云计算资源。
说明若在列表中无法选中目标云计算资源名称,请单击前往云计算资源管理,确认目标云计算资源的连通性。
源数据表
选择云计算资源下的数据表。
服务资源组
选择服务资源组。
说明上线后API的测试和调用会占用资源组,请根据资源组的规格和占用情况,选择适合的服务资源组。
新建模式
新建模式选择SQL模式。
输入SQL代码,单击语法检查及格式化,语法或数据格式无错误提示后,单击运行。
说明此处SQL语法目前仅支持SELECT操作,更多信息请参见SQL语法指南。
返回参数(自定义Header)
(可选)在返回参数(自定义Header)区域,单击新增参数,填写Header返回参数的KEY、VALUE和描述信息。
过滤器
(可选)打开过滤器开关,设置信息模块展示隐藏,更多信息,请参见API结果过滤器。
测试API:单击开始测试,核对返回内容。
配置API流量控制。
参数
说明
API最大调用QPS
API最大调用QPS应为不大于10000的正整数。当服务资源组设置为“公共资源组”时,API最大调用QPS只能为1。更多信息,请参考API流量控制支持的参数。
超时配置
请选择API单次响应超时时间。当服务资源组设置为“公共资源组”时,API单次响应超时时间限制,最大支持10s。
开启缓存
打开开启缓存开关,API调用会请求缓存。
缓存时长
当缓存开启后,可以手动设置缓存失效时间,缓存时长上限为3600秒。
API参数配置完成后,单击保存或保存并上线。
在API资源列表,可查看新建的API。
相关操作
操作项 | 说明 |
编辑API | 在API资源列表中,单击目标API操作列的编辑,在API编辑向导页面,可对API进行编辑修改。 说明
|
复制API | 在API资源列表操作列,选择更多 > 复制,在API资源列表中生成一个新的草稿API。单击复制API操作列的编辑,对复制的API进行编辑修改。 |
删除API |
说明 已上线的API不支持删除。 |
后续步骤
API创建完成后,需要对API进行上线操作,具体操作,请参见上线API。