首页 数据资源平台 实践教程 统一服务 04新建数据服务API-SQL模式

04新建数据服务API-SQL模式

更新时间: 2023-08-30 18:18:07

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

前提条件

  1. 工作组管理员账号登录。

  2. 已创建“信息中心(xxzx)”工作组,具体操作,请参见新建工作组并添加成员

  3. 已在系统设置添加“ApsaraDB for RDS”云计算资源,具体操作,请参见新建云计算资源

  4. 已创建API归属应用,具体操作,请参见新建API归属应用

背景信息

对原始数据层ApsaraDB for RDS中表“ys_xyk_bkxx”封装API。

操作步骤

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

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

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

    说明

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

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

  5. 在API资源页面右上角,单击创建API

  6. 根据配置向导创建API

    1. 配置API基础信息:输入API的名称为“查询银行客户的所有信用卡”、选择所属应用为“全域数据平台”、调用认证方式选择为“简单身份认证”,输入描述为“查询银行客户的所有信用卡”,单击下一步

    2. 配置API参数

      1. 选择云计算资源类型为“ApsaraDB for RDS”、云计算资源为“dataq_dws_rds”,新建模式选择“SQL模式”。

      2. 输入SQL代码,在页面最底部,单击语法检查及格式化,无错误提示信息后,单击下一步

        代码示例如下:

        SELECT id, zzhm, khmc, nl, yddh1
         , csrq, jysp, career, hyzk, gz
         , decdbyjybs
        FROM ys_yhkh
        WHERE zzhm = ${zzhm,string,ckr-1000};
        55
      3. 单击下一步,进入API配置及测试页面。

    3. 在API配置及测试页面,单击开始测试,查看测试结果,核对信息无误后,单击下一步

      66
    4. 在返回内容页面,查看返回示例, 单击下一步

      555
    5. 在流量控制页面,填写API最大调用次数为“3000”,选择超时设置为“3秒”,单击完成

      786

预期结果

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

阿里云首页 数据资源平台 相关技术圈