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

创建连接器

开天集成工作台已经内置了常用的连接器(公共连接器)供您直接在流编排中使用,也支持您自行创建连接器。本文介绍如何创建自定义私有连接器。

连接器采用SwaggerOpenAPI规范(当前仅支持2.0版本),规范详情可见官方文档编写指南样例参考

连接器的创建有如下方式:

从空白开始创建

  1. 在开天集成工作台界面中,选择左侧导航栏中的“连接器 > 我的连接器”,在界面右上方选择“创建我的连接器”。
  2. 设置连接器基本信息,具体的参数说明如表1所示。

    表1 参数说明

    参数

    说明

    连接器名称

    填写连接器的名称,根据规划自定义。建议您按照一定的命名规则填写连接器名称,方便您快速识别和查找。同一租户下的连接器不能重名。

    描述

    连接器的描述信息,该描述将显示在连接器的详情中,帮助用户了解连接器。

    图标

    • 支持自定义图标或选择系统图标。
    • 自定义图标要求为:格式为png、jpg,大小≦1MB。

    协议

    选择被调用API的传输协议,支持http或https。

    主机地址

    填写被调用API的主机地址。根据实际需求开启支持主机地址修改开关,开启后,可以在有连接的地方修改被访问的主机地址。

    • :表示不支持主机地址的修改。
    • :表示支持主机地址的修改。

    基准URL

    被调用API的Base URL,即域名的根路径。

    边缘节点

    可选参数。边缘节点充当桥梁,通过使用边缘节点可以在云服务中连接边缘应用,具体请参见边缘节点

    验证方式

    根据被调用API的认证方式,选择并配置连接器的安全认证方式。

    • 基本认证:用户在创建连接时提供有效的用户名(Username)和密码(Password)即可,此处无需定义。
    • API key:用户在使用连接器前需提供API密钥所需的字段,以及该验证所必须的字段值。
    • OAuth 2.0:使用Oauth 2.0身份验证框架对服务进行身份验证。 在使用此身份验证类型之前,需要向服务注册应用程序,以便它可以接收用户的访问Token。
    • IAM:该认证用于通过用户名/密码的方式来获取IAM用户的Token。
    • AK/SK:使用访问密钥ID(Ak,Access Key ID)和密钥(Sk,Secret Access Key)对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份验证。用户在创建连接时输入值即可,此处无需定义。APIG的App认证则需提供AppKey以及AppSecret。
    • 自定义:自定义用户在创建连接时的身份验证方式。
      说明:

      使用自定义认证时,如果选择使用函数,函数支持缓存时间,在这个缓存时间内,不在调用这个函数,直接使用这个缓存的调用结果。选择使用函数时,您可以进行以下操作:

      • 单击:可以直接在弹出的“创建函数”页面快速创建函数,参数配置完成后可单击“创建”保存函数。
      • 单击:选择函数后,单击该图标可以在弹出的“编辑函数”页面中快速编辑函数,参数编辑完成后可单击“更新”保存函数。
      • 单击:创建或编辑函数后,单击该图标,可刷新“选择函数名称”下拉列表中的函数列表。
      • 单击:选择函数后,单击该图标可快速复制函数。
    • 无验证:用户不需要任何身份验证即可创建与连接器的连接。无验证时,任何用户都可以使用您的连接器。
    • 行业模板:行业模板认证方式是将常见的ERP软件的认证方式内置在系统中,例如SAP Business One、钉钉等ERP系统,他们本身的认证需要使用自定义函数的方式来获取认证鉴权。为了减少客户负担,增加行业模板认证,用户不需要再写函数代码,只需要配置即可完成认证。

      用户可以选择系统内置行业模板作为连接器的验证方式。支持SAP Business One、钉钉。行业模板的详细信息请参考行业模板介绍

  3. 设置完成后,单击“创建”。

    连接器基本信息创建成功后,系统跳转至连接器详情页面。连接器显示在“连接器 > 我的连接器”页面的列表中。

    连接器“状态”为“不可用”。

    连接器需要创建触发事件/执行动作、发布、创建连接后,才能正常使用,具体请参见创建触发事件创建执行动作发布连接器连接管理

    一个连接器至少包含一个触发事件或执行动作。

导入OpenAPI文件创建

  1. 在开天集成工作台界面中,选择左侧导航栏中的“连接器 > 我的连接器”,在界面右上方选择“导入OpenAPI文件创建”。
  2. 在弹出的界面中,选择导入方式 。

    • 如果导入方式选择“本地文件”,操作步骤如下:
      1. 单击“添加文件”,选中准备好的OpenAPI文件。
      2. 单击“确定”。

        支持上传.json格式的文件,单个文件不能超过1MB,只能上传一个文件。

    • 如果导入方式选择“API资产”,操作步骤如下:
      1. 选择API文件。
      2. 资产来源选择“所有来源”或“APIHub”,资产类型选择“公共资产”或者“租户资产”。也可以输入资产名称查询相关的API资产。
      3. 选择所需要的资产名称,单击“确定”。

    创建成功后,连接器“状态”为“待发布”。

    连接器发布后,才能正常使用,具体请参见发布连接器

从APIExplorer导入创建

  1. 在开天集成工作台界面中,选择左侧导航栏中的“连接器 > 我的连接器”,在界面右上方选择“从ApiExporer导入创建”。
  2. 在弹出界面,填写连接器的信息,请参考表2

    表2 参数说明

    参数

    说明

    名称

    选择了“产品服务”后,自动显示,也可以自定义填写连接器的名称。建议您按照一定的命名规则填写连接器名称,方便您快速识别和查找。同一租户下的连接器不能重名。

    图标

    • 支持自定义图标或选择系统图标。
    • 自定义图标要求为:格式为png、jpg,大小≦1MB。

    行业分类

    在下拉框中选择API所属行业分类。

    产品服务

    选择“行业分类”后,在下拉框中选择API所属的服务。

    选择Regin

    选择API后,在下拉框中选择API所属区域。

    选择API

    选择需要的API。

    1. 在“所属模块”右侧,选择API所属模块。
    2. 勾选需要导入的API,单击

  3. 配置完成后,单击“确定”。

    创建成功后,系统跳转至连接器详情页面,检查连接器的触发事件或执行动作。连接器显示在“连接器 > 我的连接器”页面的列表中。

    连接器“状态”为“待发布”。

    连接器发布后,才能正常使用,具体请参见发布连接器

更多操作

连接器创建完成后,您可以执行如表3的操作。

表3 相关操作

操作

说明

查看连接器基本信息

在我的连接器列表中,单击连接器名称进入基本信息页签,即可查看连接器身份验证、ID、状态、创建时间、修改时间等基本信息。

查看触发事件

在我的连接器列表中,单击“触发事件”列的数字,可跳转至触发事件列表页面,您可以创建、编辑或删除触发事件。

查看执行动作

在我的连接器列表中,单击“执行动作”列的数字,可跳转至执行动作列表页面,您可以创建、编辑或删除执行动作。

编辑连接器

在我的连接器列表中,单击“操作”列的“编辑”可编辑连接器。编辑完成后需要重新发布才能在流中使用该连接器。

发布连接器

在我的连接器列表中,单击“操作”列的“发布”。连接器有任何更新,均需要重新发布后才能在流中使用,新建流默认使用新版本连接器。

共享连接器

连接器创建成功后,您可以共享连接器给其他华为云租户账号。共享连接器的操作请参见共享连接器

创建触发事件

连接器至少需包含一个触发事件或一个执行动作。创建触发事件的操作请参见创建触发事件

创建执行动作

连接器至少需包含一个触发事件或一个执行动作。创建触发事件的操作请参见创建连接器

导入OpenAPI文件更新连接器

连接器需要更新修改时,您可以通过导入OpenAPI的方式更新连接器。更新完成后需要重新发布才能在流中使用该连接器。

下载连接器

在我的连接器列表中,单击“操作”列的“下载”,可下载连接器的JSON文件。

上架连接器

在我的连接器列表中,单击“操作”列的“上架”,可申请连接器上架。上架操作请参见上架连接器

创建连接

连接器存在各种的认证配置,而连接就是来填写这些认证信息,只有在连接创建完成后,才可以正常使用连接器。创建连接的操作请参见连接管理

删除连接器

在我的连接器列表中,单击“操作”列的“删除”,可以删除单个连接器。

在我的连接器列表中,可以批量选择待删除的连接器,单击连接器上方的“删除”。

说明:
  • 用户只能删自己创建的本地连接器,而公共连接器无法删除,在执行删除操作前,请确保将云服务器上的数据已完成备份或者迁移,删除数据后,数据无法找回,请谨慎操作。
  • 批量删除连接器时,系统会自动提示正在被使用的连接器名称以及备注信息,正在被使用的连接器不允许删除。
  • 删除单个连接器时,系统会自动提示“该连接器正在被使用,请先删除正在使用的资源”,单击当前正在使用的引用资源的名称,进入资源界面进行处理,处理完毕后在进行删除。
  • 连接器未被使用时,可以直接删除。

复制连接器

在我的连接器列表中,单击“操作”列的“复制”。

系统会自动弹出复制连接器的弹框,并自动生成复制后的连接器名称,单击“确定”,复制成功。

说明:
  • 复制后的连接器名称支持自定义修改,同时系统会对复制后的连接器名称进行校验。
  • 连接器名称长度不能超过60个字符,可包含中文、大小写字母、数字及下划线、中划线、英文小括号,名称开头不能是下划线、中划线、英文小括号。
分享:

    相关文档

    相关产品