本章节为您介绍如何创建数据API,并对创建的API进行上线。

前提条件

  1. 您已经新建RDS云计算资源,详细请参见添加ApsaraDB for RDS云计算资源
  2. 您已经在RDS数据库创建表RDS数据库表语句
  3. 您已经新建组织机构,详细请参见新建服务生产方组织机构
  4. 您已经新建应用,详细请参见新建服务生产方应用

背景信息

创建API并上线API,为后续的API资产做支撑。

创建数据API

  1. 登录数据资源平台控制台
  2. 在页面左上角单击菜单,选择研发工作台,在顶部菜单栏单击资产加工
  3. 在左侧导航栏,单击统一服务 > API管理 > API资源
  4. API资源页面,单击创建API > 数据API
    1. 进入API基础信息页面,输入API的名称、选择所属应用、选择调用认证方式和输入描述等信息后,单击下一步
      API基本信息配置如下表所示:
      配置项 示例
      API名称 根据证件号码查询银行客户信息
      调用认证方式 简单身份认证
      所属应用 全域数据平台
      描述 根据证件号码查询银行客户信息
    2. 进入API参数配置页面。
      1. 选择云计算资源类型、云计算资源和源数据表,将新建模式选为向导模式
        表 1. 源数据表配置如下表所示:
        配置项 示例
        云计算资源类型 RDS
        云计算资源 客户自定义
        源数据表 yhkh
      2. 返回参数区域,选中全部字段。
      3. 若需对字段进行简单计算,可在对应字段行的函数列,单击添加,并在下拉框选择对应函数,单击保存
        表 2. 函数配置:
        字段名称 函数名称
        zzhm LENGTH
        说明 函数含义详细请参见 使用向导模式创建数据API
      4. 请求参数区域,单击请求参数,填写请求参数说明、条件和默认值,单击下一步
        表 3. API请求参数配置:
        配置项 示例
        字段名称 zzhm
        条件 =
        是否必选
        默认值 CKR-1000
  5. 进入API测试页面,单击开始测试,核对返回内容无误后,单击下一步
  6. 进入返回内容页面,查看返回内容, 单击下一步
  7. 进入流量控制页面,填写API最大调用次数,选择超时配置,单击完成
    流量控制最大调用次数配置如下表所示:
    配置项 示例
    API最大调用次数 3000
    超时配置 3秒
  8. API资源列表查看新建的API。

上线API

  1. 登录数据资源平台控制台
  2. 在页面左上角单击菜单,选择研发工作台。在顶部菜单栏单击资产加工
  3. 在左侧导航栏单击统一服务 ,单击API管理 > API资源
  4. 单击新建API后的上线,弹出上线成功提示。