如何使用向导模式创建数据API_数据资源平台-阿里云帮助中心

数据服务API是一种API类型，由云计算资源中的数据通过参数配置生成，生成的API便于后续调用，可减少资源操作成本。本文介绍如何使用向导模式创建数据API。

前提条件

本文以RDS MySQL云数据库创建API为例。

在数据服务API-创建页面，根据创建API向导信息，开始新建API。

设置API基础信息，单击下一步。

名称	说明
API名称	API的名称，自定义即可。
所属应用	选择API的归属应用。单击新增应用，可新建应用，更多信息请参见新建应用。
API Path	API调用时展示的固定路径，默认自动生成。
调用认证方式	简单身份认证和加密身份认证两种方式，更多信息，请参见认证方式说明。简单身份认证：适用于工作组内、测试等场景下的API调用，工作组内调用时用API归属应用的AppCode调用。加密身份认证：通过加密算法计算一个签名并放在请求的Header中即可调用API，具备更高的安全性，适用于API共享后，应用开发场景下API的调用。
标签	添加API的应用模块标签，可选项，便于后续统计分析。添加方式：单击加号，在添加标签对话框，选择应用及模块标签，单击确认。
描述	自定义API的描述信息，必填。

配置API参数。

（可选）在对应字段行的函数列单击添加，可为对应字段增加相应的函数，单击保存。 211

数据类型对应函数

数据类型	函数	含义
数字型（INTEGER、DOUBLE、DECIMAL）、BINARY类型、时间类型（TIME）	AVG	平均数
	COUNT	计数
	MAX	最大值
	MIN	最小值
	SUM	求和
	VARIANCE	方差
	STDDEV	标准差
字符型（STRING）、BINARY类型、时间类型（TIME）	LOWER	大写字符转小写
	UPPER	小写字符转大写
	REPLACE	替换
	SUBSTR	截取
	LPAD	左侧添加指定字符
	RPAD	右侧添加指定字符
	LENGTH	字符串长度
日期型（DATE、DATETIME）、时间类型（TIME）	DAY	日，返回日期的当月天数
	MONTH	月，返回日期的月份
	YEAR	年，返回日期的年份
	WEEKDAY	周，返回代表一周中第几天的整数
	CURRENT	返回当前日期

在请求参数区域，单击请求参数，填写请求参数字段名称、条件和默认值等。
在配置参数区域，选中返回分页结果，可根据需要设置返回结果分页索引、分页大小。
说明
当返回结果有可能超过1000条记录时，请选择返回结果分页，否则最多返回1000条记录。
单击排序字段，添加排序字段，设置返回结果按照排序字段、排序方式排列。
单击分组字段，添加分组字段，设置返回结果按照分组字段进行分组展示。
单击下一步。

API创建完成后，需要对API进行上线操作，具体操作，请参见上线API。

操作项	说明
编辑API	在API资源列表中，单击目标API操作列的编辑，在API编辑向导页面，可对API进行编辑修改。说明编辑API参数配置中的云计算资源时，需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致，如果一致可能导致编辑完成后，编辑内容不生效。
复制API	在API资源列表操作列，选择更多 > 复制，在API资源列表中生成一个新的草稿API。单击复制API操作列的编辑，对复制的API进行编辑修改。
删除API	单个删除：在API资源列表操作列，选择更多 > 删除，在删除对话框中，单击确定。批量删除：在API资源列表中选选中删除API，单击列表下方的批量删除，在批量删除对话框，单击确定。说明已上线的API不支持删除。