API流(简易版)
API流(简易版)连接器当前仅包含“响应”一个执行动作和“当收到HTTP请求时”一个触发事件。
连接参数
API流连接器无需认证,无连接参数。
当收到HTTP请求时
用户可以通过对流进行编排,保存后会在该触发事件中生成请求URL发布到APIG网关中心,当该URL被调用时,该流会被触发执行,关闭后终止。用户可参考表1进行配置。
- 输入参数
用户配置响应触发事件,相关参数说明如表1所示。
表1 当收到HTTP请求时输入参数说明 参数
必填
说明
API请求URL
是
对外开放的请求URL,保存后生成URL。在域名右侧单击“ > 管理域名”或在左侧导航选择“流编排 > API流域名管理”,可以查看配置的域名,也可以对域名进行管理,域名管理的操作请参考管理域名。
API请求方式
是
指定该URL接口以哪种方式调用触发。
API认证方式
否
APIG注册接口的认证方式。
API请求体架构
是
定义该URL接口传入的参数,参数格式以JsonSchema为准,当前支持参数位置位于query参数与Body参数。
说明:API请求体支持Json编辑器和控件两种模式。Josn编辑器模式下格式如图1所示。
响应
“响应”执行动作需和API流的触发动作一起配合使用,用户通过此执行动作可以根据需要定制接口的响应信息。
其中响应体为Json格式的字符串,响应头为键值对(key=value)形式返回。
- 输入参数
用户配置响应执行动作,相关参数说明如表2所示。
管理域名
对域名进行管理,实现任意域名生效就会运行流的目的。域名管理的操作请参考表3。
需要绑定到API分组的域名需要满足以下条件:
- 已有独立域名。
- 需要绑定的域名已经cname解析到该分组的子域名b4dff2cc395e474eb0c837624c75eac6.apig.cn-north-7.huaweicloudapis.com,否则无法绑定。
- 需要绑定的域名已经完成ICP备案,否则无法绑定。
- 如果API分组中的API支持HTTS请求协议,则需要为独立域名添加SSL证书。
操作项 |
操作及说明 |
---|---|
绑定独立域名 |
单击“绑定独立域名”,输入域名,单击“确定”。创建成功的域名展示在列表中,最多支持创建5个独立域名。 域名的格式为:abc.com |
解除绑定独立域名 |
在独立域名列表中,在对应的“操作”列下,单击“解除绑定”,单击“确定”。 |
添加SSL证书 |
当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的“操作”列下,单击“添加SSL证书”,输入已获取的证书名称、证书内容及密钥。单击“确定”。 证书内容及密钥使用的是pem编码,可以单击“样例”,查看样例。 |
查看证书 |
当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的“操作”列下,单击“查看证书”,可以查看证书详细信息。 |
编辑SSL证书 |
当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的SSL证书列下,单击,可以修改证书名称、证书内容及密码。 |
删除证书 |
当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的“操作”列下,单击“删除证书”,可以删除已添加的证书。 |