更新时间:2024-06-03 GMT+08:00
分享

创建连接器

基于已订阅的API接口创建连接器。创建连接器的四个步骤依次为创建连接器基本信息、创建触发事件/创建执行动作(本示例无需创建触发事件)、发布连接器创建连接,如图1所示。

图1 操作流程图

创建连接器基本信息

  1. 进入开天集成工作台管理控制台
  2. 在左侧导航,选择“连接器 > 我的连接器”。
  3. 在“我的连接器”界面右上方,单击“创建连接器”。
  4. 配置连接器的基本信息,如图2所示,请参考表1

    图2 配置连接器基本参数
    表1 连接器基本参数说明

    参数

    说明

    示例

    名称

    必填项。

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

    全球IP归属地查询

    描述

    选填项。

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

    全球IP归属地查询

    图标

    必填项。

    连接器的图标,显示默认图标。支持自定义图标或选择系统图标。

    自定义图标要求:格式为png、jpg,大小≤1MB。

    保持系统默认图标

    协议

    必选项。

    被调用API的传输协议,支持http或https。缺省值“https”。

    https

    主机地址

    必填项。

    被调用API的主机地址。

    qip.apistore.huaweicloud.com

    基准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。
    • 自定义:自定义在创建连接时的验证方式。
    • 无验证:用户不需要任何身份验证即可创建与连接器的连接。“无验证”时,任何用户都可以使用此连接器。
    • 行业模板:可以选择系统内置行业模板作为连接器的验证方式。目前支持SAP Business One、dingDing。

    AK/SK

  5. 单击“创建”。

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

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

创建执行动作

连接器需要添加执行动作(连接器具有的功能)并发布后,才能被使用。

  1. 在连接器详情界面,在“执行动作”页签,单击“创建执行动作”。
  2. 配置执行动作基本信息,如图3所示,请参考表2

    图3 配置执行动作基本信息
    表2 执行动作基本信息说明

    参数

    说明

    示例

    名称

    必填项。

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

    IP地址查询

    类型

    必选项。

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

    API

    可见性

    必选项。

    • 可见:在流编排中该执行动作可见。缺省值为“可见”。
    • 隐藏:在流编排中该执行动作不可见。

    可见

    描述

    选填项。

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

    IP地址查询

  3. 单击“下一步”。
  4. 配置执行动作输入信息,如图4所示,请参考表3

    根据被调用的接口请求信息配置参数。

    图4 配置执行动作输入信息
    表3 执行动作输入信息说明

    参数

    说明

    示例

    接口路径

    • 请求方式:被调用API的请求方式。
    • 请求路径:被调用API的请求路径。
    • GET
    • /lundear/qryip

    输入参数

    请求头(Header)

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

    -

    请求体(Body)

    当请求方式为“GET”或“DELETE”时,此参数不可配置。

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

    -

    查询参数(Query)

    查询参数会追加到URL。

    • 参数名称:ip
    • 显示字段:ip地址
    • 必填:勾选
    • 参数类型:string

    路径参数(Path)

    路径与路径模板一起使用,其中参数值实际上是操作URL的一部分。

    -

  5. 单击“下一步”。
  6. 配置输出信息。

    根据被调用的接口响应信息配置参数。
    1. 图5所示,请参考表4
    2. 单击“确定”,在批量导入的参数中填写显示字段别名方便阅读。如图6所示。
    图5 配置执行动作输出信息1
    图6 配置执行动作输出信息2
    表4 执行动作输出信息说明

    参数

    说明

    示例

    添加响应

    被调用API的响应码信息。缺省值为“200(请求成功)”。

    200(请求成功)

    输出参数

    响应体(Body)

    HTTP响应消息的组成部分之一,响应体呈现发送给服务器的数据。

    说明:

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

    { "status": 0, "message": "Success", "request_id": "2dd71feb-2f7a-4426-b905-4c3ff4dcceb4", "result": { "ip": "112.36.236.188", "location": { "lat": 36.68013, "lng": 117.06533 }, "ad_info": { "nation": "中国", "province": "山东省", "city": "济南市", "district": "历城区", "adcode": 370112 } } }

    响应头(Header)

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

    -

  7. 单击“保存”。

    创建执行动作后,系统自动返回至连接器详情页面,执行动作显示在“执行动作”页签列表中。连接器“状态”变为“待发布”。

发布连接器

添加执行动作后,需要发布连接器,才能创建连接。

  1. 在连接器详情页面右上方,单击“发布”,在“发布”对话框单击“确定”

    连接器“状态”变为“已发布”。

创建连接

前提条件:连接器已发布。

  1. 在连接器详情界面,“连接”页签,单击“创建连接”。
  2. 配置连接信息,如图7所示,请参考表5

    图7 配置连接信息
    表5 连接信息说明

    参数

    说明

    示例

    基本信息

    连接名称

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

    显示已选择连接器的名称,可修改。

    全球IP归属地查询

    描述

    连接的描述信息。

    -

    验证信息

    accessKey

    通过华为云“控制台 > 资源 > 我的云市场 > 已购买的服务 > 全球IP归属地查询-IP地址查询(IP归属地查询) > 资源详情”界面获取。

    获取的accessKey

    secretAccessKey

    获取的secretAccessKey

  3. 单击“保存”。

    创建连接后,系统自动返回至连接器详情页面,连接显示在“连接”页签列表中及连接列表中。

相关文档