阿里云首页 数据资源平台

使用向导模式创建数据API

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

前提条件

背景信息

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

操作步骤

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

  2. 在页面左上角,单击导航图标 图标,选择研发工作台

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

    说明

    若您已在资产加工页面,请跳过“单击资产加工”的操作。

  4. 在左侧导航栏,选择API > API管理 > API资源

  5. API资源页面右上角,选择创建API > 数据API

  6. 在创建API向导页面,开始新建API。

    1. 设置API基础信息:设置API的名称、所属应用、API Path、调用认证方式、API图标、技术支持人员、标签和描述,单击下一步1

    2. 配置API参数。

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

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

      3. 返回参数区域,选中需要使用的字段。2

      4. 在对应字段行的函数列单击添加,可为对应字段增加相应的函数,单击保存函数类型

        数据类型对应函数

        数据类型

        函数

        含义

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

        返回当前日期

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

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

        说明

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

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

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

      9. 单击下一步

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

    4. 查看返回内容:查看返回示例,单击下一步5

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

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

相关操作

操作

说明

编辑API

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

说明

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

复制API

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

删除API

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

说明

已上线的API不支持删除。

后续步骤

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