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

API流(简易版)

API流(简易版)连接器当前仅包含“响应”一个执行动作和“当收到HTTP请求时”一个触发事件。

连接参数

API流连接器无需认证,无连接参数。

当收到HTTP请求时

用户可以通过对流进行编排,保存后会在该触发事件中生成请求URL发布到APIG网关中心,当该URL被调用时,该流会被触发执行,关闭后终止。用户可参考表1进行配置。

  • 输入参数

    用户配置响应触发事件,相关参数说明如表1所示。

    表1 当收到HTTP请求时输入参数说明

    参数

    必填

    说明

    API请求URL

    对外开放的请求URL,保存后生成URL。

    API请求方式

    指定该URL接口以那种方式调用触发。

    API认证方式

    APIG注册接口的认证方式。

    • IAM认证
    • APP认证

      当选择此值时,出现“支持简易认证”开关,如果打开开关,则在流保存后该执行动作会展示用户的AppCode信息。

    • 无认证

      当选择此值时,出现“访问控制”开关,如果打开开关,则可配置IP白名单列表。

    API请求体架构

    定义该URL接口传入的参数,参数格式以JsonSchema为准,当前支持参数位置位于query参数与Body参数。

    说明:

    API请求体支持Json编辑器和控件两种模式。Josn编辑器模式下格式如图1所示。

    图1 请求体架构格式
  • 输出参数

    该触发事件无输出参数说明。

响应

“响应”执行动作需和API流的触发动作一起配合使用,用户通过此执行动作可以根据需要定制接口的响应信息。

其中响应体为Json格式的字符串,响应头为键值对(key=value)形式返回。

  • 输入参数

    用户配置响应执行动作,相关参数说明如表2所示。

    表2 响应输入参数说明

    参数

    必须

    说明

    状态码

    选择状态码,有200、201、400、401、500、502。支持输入框和下拉框两种模式。

    响应体

    设置响应体名称。

    响应头的key

    设置响应头的键,为数组模式。

    响应头的值

    设置响应头的数值,为数组模式。

    响应头

    设置响应头,需要选择数组类型的节点输出,为输入框模式。

  • 输出参数

    该执行动作无输出参数说明。

分享:

    相关文档

    相关产品