全部产品

使用向导模式创建数据API

数据API是一种由云计算资源中的数据通过参数配置生成API的API类型,本文介绍如何使用向导模式创建数据API。

前提条件

背景信息

以下以RDS云数据库创建API为例。

操作步骤

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

  2. 在菜单栏左上角,单击菜单 > 研发工作台

  3. 在顶部菜单栏单击资产加工,并在左侧导航栏选择统一服务 > API管理 > API资源

  4. API资源页面,单击页面右上角的创建API > 数据API

  5. 设置API基础信息。输入API的名称、选择所属应用、选择调用认证方式和输入描述等信息后,单击下一步API基础信息

  6. 配置API参数。

    1. 选择云计算资源类型、云计算资源和源数据表。

    2. 新建模式选为向导模式

    3. 返回参数区域,选中需要使用的字段,在对应字段行的函数列单击添加,可为对应字段增加相应的函数,单击保存函数函数类型

      数据类型对应函数

      数据类型

      函数

      函数含义

      数字型(INTEGER、DOUBLE、DECIMAL)、BINARY类型、时间类型(TIME)

      AVG

      平均数

      COUNT

      计数

      MAX

      最大值

      MIN

      最小值

      SUM

      求和

      VARIANCE

      方差

      SIDDEV

      标准差

      字符型(STRING)、BINART类型、时间类型(TIME)

      LOWER

      大写字符转小写

      UPPER

      小写字符转大写

      REPLACE

      替换

      SUBSTR

      截取

      LPAD

      左侧添加指定字符

      RPAD

      右侧添加指定字符

      LENGTH

      字符串长度

      日期型(DATE、DATETIME)、时间类型(TIME)

      DAY

      日,返回日期的当月天数

      MONTH

      月,返回日期的月份

      YEAR

      年,返回日期的年份

      WEEKDAY

      周,返回代表一周中第几天的整数

      CURRENT

      返回当前日期

    4. 请求参数区域,单击请求参数,填写请求参数字段名称、条件和默认值等。请求参数

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

      说明

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

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

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

    8. 单击下一步

  7. API测试。单击开始测试,核对返回内容无误后,单击下一步API测试

  8. 查看返回内容。查看返回示例,单击下一步返回内容

  9. 配置流量控制参数。填写API最大调用次数,选择超时配置,单击完成流量控制

执行结果

执行结果

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