更新时间:2024-04-19 GMT+08:00
分享

创建执行动作

执行动作是一个独立可执行的逻辑动作,也是连接器的最小执行单元,本质上是一个带条件调用的开放API。在流编排时可以选取到连接器的执行动作。

本章节介绍创建执行动作的操作,您可以根据实际情况选择是否创建执行动作。

前提条件

创建连接器

操作步骤

  1. 在“我的连接器”列表中,单击连接器名称,选择“执行动作”页签,单击“创建执行动作”。
  2. 设置执行动作基本信息,具体的参数说明如表1所示。

    表1 参数说明

    参数

    说明

    名称

    填写执行动作的名称,根据规划自定义。建议您按照一定的命名规则填写执行动作的名称,方便您快速识别和查找。

    类型

    • API:通过调用API的方式创建执行动作,请执行3~4
    • 函数:通过自定义函数的方式创建执行动作,请执行5。函数类型支持CDM集成。
    • 流:通过编排流的方式创建执行动作,请执行6~8

    可见范围

    • 可见:用户可见并可使用该执行动作。
    • 隐藏:用户不可查看及使用该执行动作。

    描述

    执行动作的描述信息。

  3. 单击“下一步”,设置执行动作的请求信息,具体的参数说明如表2所示。

    表2 参数说明

    参数

    说明

    接口路径

    被调用API的请求方式及请求路径。

    输入参数

    配置请求参数,如果被调用API没有请求参数可不填。

    • 请求头(Header):HTTP请求消息的组成部分之一,请求头负责通知服务器有关于客户端请求的信息。

      单击参数列表“操作”列的可以新增参数,参数配置说明请参见表3

    • 请求体(Body):HTTP请求消息的组成部分之一,请求体呈现发送给服务器的数据。
      • JSON(JSON Schema)/XML:JSON、XML格式的数据。
        导入:可直接粘贴被调用API的JSON、JSON Schema或XML数据批量导入参数,减少逐个配置参数的工作量。
        说明:

        如果请求体使用XML格式,XML header参数必须配置。

        复制:复制请求体参数的JSON或XML数据。

        预览:可以预览参数的JSON或XML结构。

        参数列表“操作”列的:可选择是否开启“是否支持根节点输入”参数,开启并发布对应连接器后,在创建流中添加该执行动作时可以自定义请求体参数的值。

        参数列表“操作”列的:新增参数,参数配置说明请参见表3

      • binary:文件格式数据。输入、输出仅支持配置一处,只支持数据流转,数据大小小于100MB。例如,输出入参数选择了“binary”,则输出不显示,反之亦成立。
    • 查询参数(Query):查询参数会追加到URL。例如,在 /items?id=#### 中,查询参数为ID。

      单击参数列表“操作”列的可以新增参数,参数配置说明请参见表3

    • 路径参数(Path):路径与路径模板一起使用,其中参数值实际上是操作URL的一部分。
    表3 参数配置说明

    参数

    说明

    参数名称

    输入参数的名称。

    显示字段

    输入该参数的别名。

    必填

    勾选该参数是否是用户必填项。

    参数类型

    选择参数类型,支持string、number、boolean、integer类型。

    说明

    关于参数的介绍说明。

    操作

    • 单击:配置参数在界面的显示样式。配置完成并发布对应连接器后,在创建流中添加该执行动作时可以查看参数的界面显示效果。
      • 参数类型:选择参数类型,支持string、number、boolean、integer类型。
      • 格式:设置用户输入该参数时界面显示的样式,可选择文本框、密码、日期时间、富文本、下拉列表。不同的参数类型可选择的格式不同。
        说明:

        当格式选择为下拉列表时,需设置分隔符和下拉列表的值。其中,分隔符只能输入单个特殊字符,如“$”、“%”、“^”、“&”等,不设置时,默认为“,”;下拉列表的值不能和分隔符一致,支持设置多个值,单击“新增”可进行添加。

        设置完成后,如果勾选了“支持多选”,则可在创建流中添加该执行动作时选择多个值,否则,只能选择一个值。

      • 可见性:设置用户输入该参数时界面显示的可见性。无:在界面中正常显示;高级:默认隐藏在高级菜单里;隐藏:该参数向用户隐藏;重要:优先显示在界面的最开始。
      • 默认值:设置该参数的预设值。
    • 单击:新增节点。
    • 单击:删除该节点。

  4. 单击“下一步”,添加响应信息,具体的参数说明如表4所示。添加完成后,执行9

    表4 参数说明

    参数

    说明

    添加响应

    根据被调用API的响应码信息添加响应码。

    输出参数

    配置响应参数,如被调用API没有响应参数可不填。

    • 响应头:HTTP响应消息的组成部分之一,响应头负责通知服务器有关于客户端请求的信息。

      单击参数列表“操作”列的可以新增参数,参数配置说明请参见表3

    • 响应体:HTTP响应消息的组成部分之一,响应体呈现发送给服务器的数据。
      • JSON(JSON Schema)/XML:JSON、XML格式的数据。
        导入:可直接粘贴被调用API的JSON、JSON Schema或XML数据批量导入参数,减少逐个配置参数的工作量。
        说明:

        如果响应体使用XML格式,XML header参数必须配置。

        复制:复制请求体参数的JSON或XML数据。

        预览:可以预览参数的JSON或XML结构。

        参数列表“操作”列的:新增参数,参数配置说明请参见表3

      • binary:文件格式数据。输入、输出仅支持配置一处。例如,输出入参数选择了“binary”,则输出不显示,反之亦成立。

  5. 单击“下一步”,设置执行动作的函数信息,具体操作如下所示。

    1. 配置输入参数。选择已创建好的函数。

      用户可以创建函数、编辑已创建的函数、复制函数以及刷新函数。创建函数的具体操作请参见创建函数

    2. 单击“下一步”,配置输出参数。

      单击“预览”可查看输入参数和输出参数。

  6. 单击“下一步”,设置执行动作的请求信息,具体的参数说明如表5所示。

    表5 参数说明

    参数

    说明

    输入参数

    支持JSON、XML、CDM格式。

    • JSON:支持参数逐个增加,也支持导入JSON格式文件。
    • XML:支持参数逐个增加,也支持导入XML格式文件。
    • CDM:支持选择行业模板。

    相关操作:

    • 复制:复制请求体参数的JSON或XML数据。
    • 预览:可以预览参数的JSON或XML结构。
    • “操作”列的:可选择是否开启“是否支持根节点输入”参数,开启并发布对应连接器后,在创建流中添加该执行动作时可以自定义请求体参数的值。
    • “操作”列的可以新增参数,参数配置说明请参见表3

  7. 单击“下一步”,设置执行动作的输出信息,具体的参数说明如表5所示。
  8. 流编排,具体操作请参考3~6

    流编排时,触发事件为“流连接器”的“定义输入”,最后一个执行动作为“流连接器”的“定义输出”。

  9. 设置完成后,单击“保存”。
  10. 测试执行动作。测试执行动作前需要先发布连接器。

    1. 在界面右上方单击“发布”发布连接器,系统自动弹出发布的提示框,单击“确定”。
    2. 单击“操作”列的“测试”进入测试界面。
    3. 在“测试”界面中,配置连接以及输入参数,配置完成后单击“提交测试”。如果没有创建连接,请先创建连接
      • 如果该连接器采用“无验证”方式,则无需配置连接。
      • 如果输入或输出为文件格式,则不支持测试。
    4. 测试完成后,可查看测试结果和测试历史。
      • 如果测试通过,表示执行动作创建完成。
      • 如果测试不通过,您可以单击“操作”列的“编辑”修改执行动作。修改完成后单击界面右上方“发布”重新发布连接器,再对该执行动作进行测试。

更多操作

执行动作创建完成后,您可以执行如表6的操作。

表6 相关操作

操作

说明

编辑执行动作

在执行动作列表,单击“操作”列的“编辑”可编辑执行动作。

测试执行动作

在执行动作列表,单击“操作”列的“测试”可测试执行动作。

说明:

测试执行动作前需要先发布连接器。

删除执行动作

在执行动作列表,单击“操作”列的“删除”可删除执行动作。

说明:

删除执行动作后无法恢复,请谨慎操作。

相关文档