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

API流

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

当使用API流连接器时,需要添加APIG Administrator权限,如图1所示。

图1 APIG Administrator权限

连接参数

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

当收到HTTP请求时

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

  • 输入参数

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

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

    参数

    必填

    说明

    API请求URL

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

    API请求方式

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

    API认证方式

    APIG注册接口的认证方式。

    • IAM认证
    • APP认证
    • 无认证

    API请求体架构

    定义该URL接口传入的参数,参数格式以JsonSchema为准,当前支持参数位置位于query参数与Body参数。支持JsonSchema编辑器、控件组件模式。JsonSchema编辑器如图2所示。

    获取URL

    API流的触发事件的数据填写完毕后,请单击“保存”自动生成URL,否则数据会丢失。

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

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

响应

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

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

  • 输入参数

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

    图3 响应输入参数
    表2 响应输入参数说明

    参数

    必须

    说明

    响应体

    设置响应体名称。

    状态码

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

    响应头

    当为输入框模式时,显示此参数。

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

    响应头 > 响应头的key

    当为数组模式时,显示此参数。

    设置响应头的键。

    响应头 > 响应头的值

    当为数组模式时,显示此参数。

    设置响应头的数值。

  • 输出参数

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

相关文档