创建数据更新API
数据更新API是指通过调试或调用创建的数据更新API修改数据库中的表数据,专业模式下的工作组不支持该API的创建。本文介绍如何创建数据更新API。
前提条件
已创建工作组,具体操作,请参见新建工作组。
已创建云计算资源,具体操作,请参见新建RDS MySQL云计算资源或新建AnalyticDB PostgreSQL云计算资源。
已创建应用,具体操作,请参见新建应用。
操作步骤
登录数据资源平台控制台。
在页面左上角,单击
图标,选择研发工作台。
在顶部菜单栏,单击
图标,选择目标工作组,单击资产加工。
说明若您已在资产加工页面,请跳过“单击资产加工”的操作。
在左侧导航栏,单击
图标,选择API开发 > 数据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数据适配器开关,设置信息模块展示隐藏,更多信息,请参见API结果过滤器。
查看返回示例:确认返回信息无误后,单击下一步。
配置流量控制参数:填写API最大调用次数,选择超时配置,单击完成。
在API资源列表,可查看新建的API。
相关操作
操作项 | 说明 |
编辑API | 在API资源列表中,单击目标API操作列的编辑,在API编辑向导页面,可对API进行编辑修改。 说明 编辑API参数配置中的云计算资源时,需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致,如果一致可能导致编辑完成后,编辑内容不生效。 |
复制API | 在API资源列表操作列,选择更多 > 复制,在API资源列表中生成一个新的草稿API。单击复制API操作列的编辑,对复制的API进行编辑修改。 |
删除API |
说明 已上线的API不支持删除。 |
后续步骤
API创建完成后,需要对API进行上线操作,具体操作,请参见上线API。