配置API输出组件

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

前提条件

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

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

操作步骤

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

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

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

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

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

  6. 单击并拖动目标输入、转换或流程组件的image图标,将其连接至当前API输出组件上。

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

    参数

    描述

    步骤名称

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

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

    • 长度不超过64个字符。

    数据源

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

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

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

    请求方式

    API数据源配置的请求方式显示,默认选择为POST。

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

    • PUT:可配置ParamsHeaders,允许为空。

    请求的数据结构

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

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

    • 数组数据:一次请求以数组形式传递一批数据,每次传递的数据量为批量条数的值。选择该方式,支持配置批量读取条数。

      • 批量读取条数:一次请求的数据条数。

    URL路径(非必填)

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

    写入JSON路径(非必填)

    数据写入JSON对象的路径,例如data.result。此处所填写的路径将被系统自动拼接在输出字段名前,作为完整路径写入。

    请求参数

    请求参数中包含ParamsHeadersBody(仅当请求方式选择为POST时支持)和签名

    Params、Headers、Body

    • 参数名称:支持中文、英文和特殊字符。

    • 参数类型:可选择常量时间戳随机数

    • 参数值:当参数类型选择为常量时,参数值支持输入中文、英文和特殊字符;当参数类型选择为时间戳时,参数值仅支持自动生成;当参数类型选择为随机数时,参数值可选择自动生成为163264128位随机数。

    • 数据类型:仅在Body中,支持配置数据类型,可选择StringLongJSONDoubleBooleanDate,默认为String。

    • 操作

      • 新建:单击+新建,新增一行参数,单击image图标保存此参数后,方可再新建下一个参数。单击image可取消填写此参数。

      • 编辑:单击已配置完成参数操作列的image图标,可编辑此参数各项配置。

      • 移动:单击已配置完成参数操作列的image图标,可将此参数移动至非当前列表中,例如当前参数在Param列表中,移动时可选择移动至HeaderBody中。若目标列表中已存在同名参数,则不支持移动;若移动的目标列表为Body,但Body的输入方式为JSON,则不支持移动。

      • 删除:单击已配置完成参数操作列的image图标,可删除当前参数,若参数被签名配置引用,则不允许删除。

    Body的输入格式可选择为JSONKey-Value

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

    • Key-Value:单击新建,分别输入参数名称和参数值,并选择当前参数的参数类型和数据类型。

    签名

    签名默认关闭,启用签名后,需配置签名的生成规则。

    • 签名名称:用户封装请求参数Key值。

    • 签名位置:可选择ParamsHeaderBody(仅当请求方式为POST时支持)。

    • 引用参数:可选择多个参数列表中的KV参数。

    • 生成函数:可选择MD5HEXHMAC-MD5HMAC-SHA256HMAC-SHA1

    • 密钥:可选择治理 > 数据安全 > 密钥管理中的密钥,或手动输入密钥。

      若当前Dataphin实例未购买资产安全增值模块,则仅支持手动输入;若当前Dataphin实例已购买资产安全增值模块,则仅支持选择治理 > 数据安全 > 密钥管理中的密钥。若下拉列表中无可选密钥,可单击前往注册,跳转至治理 > 数据安全 > 密钥管理中注册密钥。

      说明

      当生成函数选择为MD5HEX时,此参数为非必填。

    • 拼接内容:可选择仅参数值参数名称+参数值,默认为参数名称+参数值。

    • 拼接顺序:可选择按字典顺序按选择顺序,默认为按字典顺序。

    • 拼接方式:可选择固定连接符无连接符,默认为固定连接符。

      说明

      仅当拼接内容选择为参数名称+参数值时,支持配置此参数。

    • 拼接示例:根据上方配置,展示拼接后的字符串。若参数中使用了时间戳或随机数,则此处展示临时生成的值。

    输入字段

    根据上游组件的输出,为您展示输入字段。

    输出字段

    为您展示输出字段。 Dataphin支持通过批量添加新建输出字段的方式配置输出字段:

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

      • 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)、分号(;)、点(.)。

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

    • 新建输出字段。

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

    • 复制上游字段。

      单击复制上游字段,系统将根据上游的字段名自动生成输出字段。

    • 管理输出字段。

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

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

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

    映射关系

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

    • 同名映射:对字段名称相同的字段进行映射。

    • 同行映射:源表和目标表的字段名称不一致,但字段对应行的数据需要映射。只映射同行的字段。

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