更新时间:2024-07-16 GMT+08:00
分享

设置执行动作

自定义连接器创建成功后,请设置连接器连接到第三方系统后想要执行的操作,如获取信息等。

前提条件

创建自定义连接器

操作步骤

  1. 在“我的连接器”页签,双击连接器卡片,或者将鼠标悬停在连接器上单击右下角,进入连接器详情页面。
  2. 在页面下方“设置动作”模块,单击“增加执行动作”。
  3. 设置执行动作基本信息和请求信息。

    1. 设置基本信息,具体参数说明如表1所示。
      表1 设置基本信息

      参数

      说明

      唯一标识

      用于识别不同的操作。执行动作创建成功后,不支持修改唯一标识。

      动作名称

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

      动作描述

      执行动作的描述信息。

      图1 设置基本信息
    2. 设置请求信息,具体参数说明如表2所示。
      表2 设置请求信息

      参数

      说明

      请求地址

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

      请求方式

      根据 HTTP 接口类型选择。包含GET、POST、DELETE、PUT。

      • GET:请求服务器返回指定资源。
      • POST:请求服务器新增资源或执行特殊操作。
      • DELETE:请求服务器删除指定资源,如删除对象等。
      • PUT:请求服务器更新指定资源。

      请求参数

      配置请求参数,如被调用API没有请求参数可不填。设置参数基本信息请参见表3

      • Query:查询参数,通常指的是 URL 的问号?后面附加的参数。例如,在 /items?id=#### 中,查询参数为ID。

        在“Query”参数下方单击“增加执行条件”可新增参数。

      • Body:请求体,HTTP请求消息的组成部分之一,请求体呈现发送给服务器的数据。
        说明:

        当请求方式为GET时,Body不可选。

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

        在“Header”参数下方单击“增加执行条件”可新增参数。

      • Path:路径参数,代表 URL 中配置的带大括号的变量,比如 {pathParam} ,其中 pathParam 会作为变量名。
        说明:

        请求地址中{id}格式的变量将会被自动添加到Path 变量列表中,无需手动添加。

      返回参数

      输入Body的数据结构,单击“解析”,下方将返回解析后的参数。配置连接器时,以解析后的字段为准。

表3 设置基本信息

参数

说明

参数

需要输入的参数。

名称

设置该参数的名称,在测试或调用该执行动作时会显示名称。

参数描述

对参数的解释说明,在调用该执行动作时会显示参数描述。

默认值

设置参数默认值,在测试或调用该执行动作时,该参数默认显示的值。

说明:

Body参数可以设置默认值。

必填

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

操作

对该参数的具体操作项。

删除参数:单击“删除”即可。

图2 设置请求信息
  1. 设置完成后,单击右上角“创建”。

    页面提示“创建成功”,表示执行动作创建成功。

  2. 测试执行动作,在“执行动作”处右侧单击“测试”,进入测试页面。

    图3 测试执行动作

  3. 输入请求参数实际值,单击“测试”。

    • 状态显示“成功”,表示执行动作可以正常使用。
    • 状态显示“失败”,表示执行动作异常,可以修改执行动作,重新测试。

更多操作

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

表4 更多操作

操作

说明

编辑执行动作

双击执行动作卡片,或者将鼠标悬停在执行动作上单击右侧,进入执行动作页面编辑执行动作。

删除执行动作

将鼠标悬停在执行动作上,单击右侧即可删除执行动作。

测试执行动作

双击执行动作卡片,或者将鼠标悬停在执行动作上单击右侧,进入执行动作页面,在“执行动作”处右侧单击“测试”即可测试执行动作。

相关文档