配置API输入组件

配置API输入组件后,可以读取API数据源中的数据至Dataphin,进行数据集成与数据开发。本文为您介绍如何配置API输入组件。

前提条件

  • 已创建API数据源。具体操作,请参见创建API数据源

  • 进行API输入组件属性配置的账号,需具备该数据源的同步读权限。如果没有权限,则需要申请数据源权限。具体操作,请参见申请数据源权限

操作步骤

  1. 在Dataphin首页顶部菜单栏,选择研发 > 数据集成

  2. 在集成页面顶部菜单栏选择项目(Dev-Prod模式需要选择环境)。

  3. 在左侧导航栏中单击离线集成,在离线集成列表中单击需要开发的离线管道,打开该离线管道的配置页面。

  4. 单击页面右上角的组件库,打开组件库面板。

  5. 组件库面板左侧导航栏中需选择输入,在右侧的输入组件列表中找到API组件,并拖动该组件至画布。

  6. 单击API输入组件卡片中的image图标,打开API输入配置对话框。

  7. API输入配置对话框中,配置以下参数。

    参数

    描述

    步骤名称

    即API输入组件的名称。Dataphin自动生成步骤名称,您也可以根据业务场景修改。命名规则如下:

    • 只能包含中文、字母、下划线(_)、数字。

    • 长度不超过64个字符。

    数据源

    在数据源下拉列表中,展示当前Dataphin中所有API类型的数据源,包括您已拥有同步读权限的数据源和没有同步读权限的数据源。

    • 对于没有同步读权限的数据源,您可以单击数据源后的申请,申请数据源的同步读权限。具体操作,请参见申请数据源权限

    • 如果您还没有API类型的数据源,单击新建,创建数据源。具体操作,请参见创建API数据源

    请求方式

    支持POST请求和GET请求。

    • POST:可配置ParametersHeadersBody,允许为空。

    • GET:可配置ParametersHeaders,允许为空。

    URL路径

    非必填,输入URL中的路径,此处填写的路径参数将会同数据源中配置的URL进行请求URL的拼接。例如,数据源中配置的URL为https://www.aliyun.com,填写的URL路径为/home,则请求URL为https://www.aliyun.com/home

    读取JSON路径(非必填)

    填写JSON路径将按照路径进行读取数据,例如data.result;不填写则读取返回数据。

    请求次数

    支持一次请求多次请求

    • 一次请求:只进行一次请求。

    • 多次请求:根据指定循环的参数,进行多次请求。

      • 请求参数:需要在Parameters或Body中配置,参数内容需为数字。

      • 最大请求次数:每次定时任务查询的最大请求次数,例如,填写为500。超过500次请求则终止任务。

      • 高级配置

        • 请求起始值:循环请求的起点,起点包含在循环请求之内。

        • 请求终止值:循环请求的终点,终点包含在循环请求之内。

        • 请求步长:循环请求的步长,默认为1。

    请求参数

    请求参数框用于构造API请求的参数定义,例如分页页码,需要在ParametersHeaders或者Body中携带。

    • ParametersHeadersBody均支持中文输出。例如,key分页Value500类型String

    • ParametersHeadersBody均支持使用特殊字符。例如,空格、$、+、&等字符。

    • 当请求方式选择为POST时,支持配置Body。输入格式可选择为JSONKey-Value

      • JSON:需要在JSON代码编辑区域输入相应JSON代码。单击image图标,系统将自动格式化(美化)所输入的代码。

      • Key-Value:单击新建,分别输入Key和Value,并选择当前参数的类型。单击image图标保存此参数后,方可再新建下一个参数。

    输出字段

    为您展示输出字段。 您可以手动添加输出字段:

    • 批量添加输出字段。

      • 格式:单击批量添加 ,支持以JSON格式和TEXT格式批量配置。

        • JSON格式:

          // 示例:
          [{
            "index": "0",
            "name": "user_id",
            "type": "String"
           },
           {
            "index": "1",
            "name": "user_name",
            "type": "String"
           }]
          说明

          index表示指定对象的列编号,name表示引入后的字段名称,type表示引入后的字段类型。例如:"index":3,"name":"user_id","type":"String" 表示把文件中的第4列引入,字段名为user_id,字段类型为 String。

        • TEXT格式:

          // 示例:
          0,user_id,String
          1,user_name,String
      • 行分隔符列分隔符:批量添加格式TEXT时,支持配置行分隔符和列分隔符。行分隔符用于分隔每个字段的信息,默认为换行符\n,可支持\n ; . ;列分隔符用于分隔字段名与字段类型,默认为英文逗号(,)。

    • 新建单个输出字段。

      单击新建输出字段,根据页面提示填写来源序号字段并选择类型。单击image图标保存当前行,单击image图标删除当前行。

    • 管理输出字段。

      对已添加的字段,您可以执行如下操作:

      • 单击操作列下的agag图标,编辑已有的字段。

      • 单击操作列下的agfag图标,删除已有的字段。

  8. 单击确认,完成API输入组件的属性配置。