配置接口策略

接口策略应用于接口以实现对接口访问的控制，包括代理缓存策略、安全控制策略、流量控制策略，详细说明如下：

配置代理缓存策略

为接口配置代理缓存策略，可以在短时间内由网关缓存接口信息，方便同一用户的频繁调用，减少后端服务的访问压力。

  1. 单击左侧导航树中的[服务发布/代理缓存]菜单项。

  1. 在界面左上方，选择待新建访问策略的服务网关。

  1. 单击<新建缓存策略>按钮，弹出配置窗口。

  1. 配置策略参数，然后单击<确定>按钮。

  1. 在缓存策略列表中，选择缓存策略对应的<绑定接口>按钮

  1. 根据接口分组筛选接口，然后选择要绑定的接口。单击<确定>按钮，将策略绑定到接口。代理缓存策略参数如下表：

参数

说明

策略名称

该策略在本系统的显示名称，发布接口时需根据此名称选择策略。

缓存TTL

缓存过期时间，单位为秒，取值范围为取值范围为1~31536000秒。

匹配返回码

匹配的返回码，只缓存系统定义的返回码，默认为：200、301、404。

匹配Content-Type

被认可的返回Content Type参数。不填则不校验该参数。

匹配Header

缓存校验的请求Header。不填则不校验该参数。

匹配查询参数

缓存校验的查询参数。不填则不校验该参数。

 

配置安全控制策略

配置访问策略

  1. 单击左侧导航树中的[服务发布/安全控制]菜单项，进入访问策略管理页面。

  1. 在界面左上方选择待新建访问策略的服务网关。

  1. 单击<新建访问控制策略>按钮，弹出配置窗口。

  1. 配置策略。然后单击<确定>按钮。

  1. 选择访问策略对应的<绑定接口>按钮。

  1. 根据接口分组筛选接口，然后选择要绑定的接口。单击<确定>按钮，将策略绑定到接口。访问策略参数参数如下表：

参数

说明

策略名称

该策略在本系统的显示名称，发布接口时需根据此名称选择该策略。

限制类型

支持通过配置IP地址黑白名单和拦截规则来限制访问请求。当前IP地址不支持配置VPC的私网地址。

动作

通过IP地址限制访问请求时配置，单击<添加IP地址>添加受限制的IP地址或IP地址段。

  • 允许：白名单方式，仅允许与IP地址匹配的请求访问接口。

  • 禁止：黑名单方式，除与IP地址匹配的请求外，均允许访问接口。

配置规则

通过连接规则限制访问请求时配置，可参考界面上的模板示例编写规则。

 

配置认证策略

  1. 单击左侧导航树中的[服务发布/安全控制]菜单项，进入安全控制管理页面。

  1. 在界面左上方选择待新建认证策略的服务网关。

  1. 单击[认证策略]页签，进入认证策略管理页面。

  1. 单击<新建认证策略>按钮，弹出配置窗口。

  1. 配置策略。然后单击<确定>按钮。认证策略参数如下表：

参数

说明

策略名称

该策略在本系统的显示名称，发布接口时需根据此名称选择该策略。

认证类型

支持对请求进行基础认证或密钥认证。

  • 基础认证：自定义用户名和密码。

  • 密钥认证：配置密钥KEY用作后续接口的权限校验，如果不指定，将会报错。

  • AK/SK认证：所需配置如下，在发布接口时选择本认证后，还需进行服务订阅配置，订阅成功后，服务消费者如何生成认证头部Authorization、完成接口访问的详细操作请<点击下载>，参考说明文档。

  • 签名必选Header字段：制定签名字段中需要选取的header字段，以及header字段的顺序。

  • 签名算法：指定签名计算中使用的算法。

  • 校验body：是否校验body内容。开启body校验会占用较多的计算资源，默认有效的校验body最大体积为8kilobytes。

  • JWT认证：所需配置如下，在发布接口时选择本认证后，还需进行服务订阅配置，订阅成功后，服务消费者如何生成认证头部Authorization、完成接口访问的详细操作请<点击下载>，参考说明文档。

  • Token TTL：Token的过期时间。当token过期时，应该重新获取新的临时token。

  • Oauth2认证：决定第三方应用代表用户的访问权限。：所需配置如下，在发布接口时选择本认证后，还需进行服务订阅配置，订阅成功后，服务消费者如何生成认证头部Authorization、完成接口访问的详细操作请参见。

  • Token Expiration：Access Token的过期时间。当token过期时，应该重新获取新的临时token。

  • 认证路径：该认证的访问路径。

  • 供应密钥：不填则默认生成密钥。

  • 访问范围：允许访问的地址范围。

  • 描述：关于此认证的描述。

 

  1. 选择访问策略对应的<绑定接口>按钮。

  1. 根据接口分组筛选接口，然后选择要绑定的接口。单击<确定>按钮，将策略绑定到接口。

配置流量控制策略

  1. 单击左侧导航树中的[服务发布/流量控制]菜单项，进入流控策略管理页面。

  1. 在界面左上方选择待新建流控策略的服务网关。

  1. 单击<新建流控策略>按钮，弹出配置窗口。

  1. 配置流控策略参数，然后单击<确定>按钮。流量控制策略参数如下表：

参数

说明

策略名称

该策略在本系统的显示名称，发布接口时可根据此名称选择该策略。

配置类型

  • 基础配置：通过配置单位时间的请求数量限制，超过限制的请求将被限流。

  • 限流模式：配置限流的模式，可以以接口、项目、凭证和源IP为对象进行限流。

  • 每秒/分钟/小时/天请求数：在配置栏中填写次数，即每秒、每分钟、每小时、每天限制的请求次数。4个条件均为必填项，任何一个条件达到阈值时就会被限流。如某条件不需设限，填写“-1”即可。例如，每秒请求数设置为100，则当一秒钟内请求次数超过100后，会被自动限流。

  • redis地址/端口/密码：流量控制采用的是redis对接，需要输入redis的相关参数。

  • 自定义配置：除配置单位时间请求数量限制外，还支持自定义配置限流的例外情况，即符合条件的请求将作为例外不被限流。可参考界面上的模板示例编写策略。

 

  1. 选择流控策略对应的<绑定接口>按钮。

  1. 根据接口分组筛选接口，然后选择要绑定的接口。单击<确定>按钮，将策略绑定到接口。