发布接口

  1. 在左边导航树单击[产品与服务],在右边窗口选择[企业应用/服务网关]菜单项,进入服务网关页面。

  1. 在网关实例列表中,点击实例名称链接,进入实例详情页面。

  1. 单击左导航树中的[服务发布/接口管理]菜单项,进入接口管理页面。

  1. 在界面左上方选择待发布接口的服务网关。

  1. 单击<发布接口>按钮,弹出配置窗口。

  1. 配置基础配置、接入后端服务、定义接口情况、接口策略等参数。

  1. 参数配置完成后,单击<新建>按钮,完成操作。

  1. 服务消费者根据新建网关时配置的网关IP、端口号和本步骤中配置的请求地址即可访问本接口。

基础配置

基础配置参数如下表:

参数

说明

基础配置

接口名称

接口在本系统的显示名称,策略绑定接口、订阅服务时需通过此名称选择本接口。

接口分组

选择新建接口组配置的分组,实现接口间的逻辑隔离和统一管理。

 

接入后端服务

1.      后端服务类型为HTTP/HTTPS

后端服务类型为HTTP/HTTPS类型时,需要配置的参数说明如下表:

 

参数

说明

接入后端服务

后端服务类型

本接口可代理的后端服务的类型,选择HTTP/HTTPS

请求协议

本接口请求后端服务时使用的协议类型,包括HTTPHTTPS

请求方法

本接口请求后端服务的方法,即API接口的请求方法,包括GETPOSTDELETEPUTPATCHHEADOPTIONSANY

后端服务Path(默认)

本接口负责代理的服务提供方的路径,支持精确匹配。

格式如:/users/{userId}/projects

{}中的变量为请求参数,表示匹配"/"之间的一整段,不支持匹配"/"之间的一部分,例如/abc{userId}。若匹配模式为绝对匹配,则尾部的请求参数可以添加+号,例如/users/{p+},其中变量p匹配1或多段"/"之间的部分。

请求Path中包含请求参数时,必须设置对应的入参定义。

内容区分大小写。

后端服务(默认)

  • 服务地址:本接口负责代理的服务提供方的IP地址/域名和端口号,格式为“主机:端口”,端口号未指定则使用默认端口。HTTP协议,默认端口号为80HTTPS协议,默认端口号为443。单击按钮可添加多个后端服务,实现后端服务的负载均衡。

  • 权重:当配置多个后端服务时,可以通过配置权重实现后端服务的负载均衡轮询。例如后端服务ab的权重分别为500200,则访问请求到ab的比例分别为5/72/7

  • 负载均衡算法:

  • 默认为“轮询”,即通过权重实现负载均衡。

  • 最小连接:将请求发送给当时连接数最小的后端服务处理。

  • 一致性哈希:需配置哈希类型和参数,系统会自动计算出hash值完成负载均衡。支持的类型包括HeaderCookieIP

重试次数(次)

重试次数:为请求指定重试次数。超过重试次数后仍未成功,则请求失败。

超时时间(毫秒)

请求超时时间(s),即每次请求的超时时间。超时仍未成功,则执行重试。

如果在API调试过程中,遇到后端响应超时之类的错误,请适当调大后端超时时间,以便排查原因。

版本号/版本特性

配置该接口的版本号,说明版本特性。版本号默认为v1

配置健康检查

TCP检查间隔

设置TCP检查的时间间隔,取值范围为5~300秒。

超时时间

设置TCP连接超时时间,取值范围为1~60秒。

不健康阈值

设置不健康阈值,单位为次。在当前状态为健康的情况下,后端服务请求失败的次数达到阈值时,即标记为不健康。后端服务请求失败存在包括两种情况:TCP连接失败和后端服务响应超时。

健康阈值

设置健康阈值,单位为次。在当前状态为不健康的情况下,TCP检查成功的次数达到阈值,即标记为健康。

 

2.      后端服务的类型为WebService

后端服务类型为WebService时,参考下图配置:

 

定义接口请求和策略配置

接口请求和策略参数如下表所示:

参数

说明

定义接口请求

请求协议

服务消费者请求本接口时使用的协议类型,包括HTTPHTTPS

应与接入后端服务时配置的协议保持一致。

请求方法

服务消费者请求本接口的方法,即API接口的请求方法,包括GETPOSTDELETEPUTPATCHHEADOPTIONSANY

应与接入后端服务时配置的协议保持一致。

请求地址

服务消费者请求本接口时的路径,支持精确匹配。

服务消费者可根据新建网关时配置的网关IP、端口号和本请求地址访问本接口。

配置策略

安全认证

选择认证策略策略,如无安全认证需求,选择“无认证”。

访问策略

选择访问策略策略,如无访问策略限制需求,不用选择。

流控策略

选择流量控制策略,如无流控策略限制需求,不用选择。