文档

使用向导模式创建数据服务API

更新时间:

数据服务API是一种API类型,由云计算资源中的数据通过参数配置生成,生成的API便于后续调用,可减少资源操作成本。向导模式适用于单表的简单查询,零代码通过界面化的设置完成API的封装。本文介绍如何使用向导模式创建数据API。

前提条件

背景信息

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

操作步骤

  1. 登录数据资源平台控制台

  2. 在页面左上角,单击导航图标 图标,选择协同

  3. 在顶部菜单栏,单击选择工作组图标,选择目标工作组,单击资产加工

  4. 在左侧导航栏,单击API图标,选择API开发 > 数据服务API

  5. 数据服务API页面右上角,单击创建API

  6. 数据服务API-创建页面,开始创建API。

    1. 基础信息区域,设置API的基础信息。

      参数

      说明

      API名称

      API的名称,自定义即可。

      所属应用

      选择API的归属应用。单击新增应用,可新建应用,更多信息请参见新建应用

      服务协议

      选择服务的协议类型。

      API Path

      API调用时展示的固定路径,默认自动生成。

      调用认证方式

      简单身份认证加密身份认证两种方式,更多信息,请参见认证方式说明

      • 简单身份认证:适用于工作组内、测试等场景下的API调用,工作组内调用时用API归属应用的AppCode调用。

      • 加密身份认证:通过加密算法计算一个签名并放在请求的Header中即可调用API,具备更高的安全性,适用于API共享后,应用开发场景下API的调用。

      标签

      添加API的应用模块标签,可选项,便于后续统计分析。

      添加方式:单击加号,在添加标签对话框,选择应用及模块标签,单击确认

      描述

      自定义API的描述信息,必填。

    2. 参数配置区域,配置API参数。

      参数

      说明

      云计算资源

      选择云计算资源。

      说明

      若在列表中无法选中目标云计算资源名称,请单击前往云计算资源管理,确认目标云计算资源的连通性。

      源数据表

      选择云计算资源下的数据表。

      服务资源组

      选择服务资源组。

      说明

      上线后API的测试和调用会占用资源组,请根据资源组的规格和占用情况,选择适合的服务资源组。

      新建模式

      新建模式选择向导模式

      返回参数

      1. 返回参数区域,选中需要返回的字段。

      2. (可选)在返回参数的函数列单击添加,可为对应字段增加相应的函数。各数据类型对应的函数说明如表数据类型对应的函数所示。

      返回参数(自定义Header)

      (可选)在返回参数(自定义Header)区域,单击新增参数,填写Header返回参数的KEY、VALUE和描述信息。

      请求参数

      (可选)在请求参数区域,单击新增参数,填写请求参数的字段名称、参数名称、条件、是否必填、默认值、授权时筛选等。

      说明

      授权时筛选若选择,在授权页面,会展示授权过滤配置项,具体操作,请参见授权API

      配置参数

      (可选)打开配置参数开关,配置API参数。

      1. 配置参数区域,选中返回分页结果,可根据需要设置返回结果分页索引、分页大小。

        说明

        当返回结果有可能超过1000条记录时,请选择返回结果分页,否则最多返回1000条记录。

      2. 单击排序字段,添加排序字段,设置返回结果按照排序字段、排序方式排列。

      3. 单击分组字段,添加分组字段,设置返回结果按照分组字段进行分组展示。

      过滤器

      (可选)打开过滤器开关,设置信息模块展示隐藏,更多信息,请参见API结果过滤器

      数据类型对应的函数

      数据类型

      函数

      含义

      数字型(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

      返回当前日期

    3. 测试API:单击开始测试,核对返回内容。

    4. 配置API流量控制。

      参数

      说明

      API最大调用QPS

      API最大调用QPS应为不大于10000的正整数。当服务资源组设置为“公共资源组”时,API最大调用QPS只能为1。更多信息,请参考API流量控制支持的参数

      超时配置

      请选择API单次响应超时时间。当服务资源组设置为“公共资源组”时,API单次响应超时时间限制,最大支持10s。

      开启缓存

      打开开启缓存开关,API调用会请求缓存。

      缓存时长

      当缓存开启后,可以手动设置缓存失效时间,缓存时长上限为3600秒。

  7. API参数配置完成后,单击保存保存并上线

    在API资源列表,可查看新建的API。

相关操作

操作项

说明

编辑API

在API资源列表中,单击目标API操作列的编辑,在API编辑向导页面,可对API进行编辑修改。

说明
  • 编辑API参数配置中的云计算资源时,需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致,如果一致可能导致编辑完成后,编辑内容不生效。

  • 修改服务资源组后,会影响API Path。

复制API

在API资源列表操作列,选择更多 > 复制,在API资源列表中生成一个新的草稿API。单击复制API操作列的编辑,对复制的API进行编辑修改。

删除API

  • 单个删除:在API资源列表操作列,选择更多 > 删除,在删除对话框中,单击确定

  • 批量删除:在API资源列表中选中删除API,单击列表下方的批量删除,在批量删除对话框,单击确定

说明

已上线的API不支持删除。

后续步骤

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

  • 本页导读 (0)