文档

配置API输出组件

更新时间:

配置API输出组件,可以将外部数据库中读取的数据写入到API,或从大数据平台对接的存储系统中将数据复制推送至API,进行数据整合和再加工。本文为您介绍如何配置API输出组件。

前提条件

在开始执行操作前,请确认您已完成以下操作:

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

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

操作步骤

  1. 请参见离线管道组件开发入口,进入离线管道脚本的开发页面。

  2. 按照下图操作指引,进入API输出配置对话框。

    image

  3. API输出配置对话框,按照下表配置参数。

    参数

    说明

    步骤名称

    命名规则如下:

    • 仅支持中文、字母、数字及下划线(_)。

    • 最多输入 64 个字符。

    数据源

    选择Dataphin已配置的数据源。同时您可以单击数据源后的新建,进入规划模块新建数据源。具体操作,请参见创建API数据源

    进行属性配置的账号需具备该数据源的同步写权限,如果没有权限,则需要申请数据源权限,详情请参见申请数据源权限

    请求方式

    按API数据源配置的请求方式显示。

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

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

    请求参数框为构造API请求的参数定义,例如分页页码,需要在Parameters或者Body中携带。ParametersBody支持中文输出,例如:key-分页,Value-500,类型-String。

    请求的数据结构

    请求传递的JSON数据的格式。

    单条数据:一次请求只传递一条数据,有几条数据就进行几次请求。

    多条数据:一次请求以数组形式传递一批数据,每次传递的数据量为批量条数的值。

    URL路径

    非必填,输入URL中的路径,此处的路径会被拼接数据源中配置的URL后。

    写入JSON路径

    非必填,填写JSON路径后可读取数组数据,不填写则读取单条数据。

    输入字段

    展示上游的输入字段。

    输出字段

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

    • 单击批量添加

      • 以JSON格式批量配置,例如。

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

        name表示引入的字段名称,type表示引入后的字段类型。 例如:"name":"user_id","type":"String"表示把字段名为user_id的字段引入,设置字段类型为String。

      • 以TEXT格式批量配置,例如。

        // 示例:
        user_id,String
        user_name,String
        • 行分隔符用于分隔每个字段的信息,默认为换行符(\n),可支持换行符(\n)、分号(;)、点(.)。

        • 列分隔符用于分隔字段名与字段类型,默认英文逗号(,)。

    • 单击新建输出字段,根据页面提示填写字段及选择类型

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

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

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

    映射关系

    根据上游的输入和目标表的字段,可以手动选择字段映射。快速映射包括同名映射同行映射

  4. 单击确认完成API输出组件配置

  • 本页导读 (0)
文档反馈