管理接口

包括如下内容：

查看接口详情

接口版本管理

冻结/解冻接口

上下线接口

编辑接口

删除接口

导出已发布的后端服务接口

查看接口详情

您可以执行本操作查看接口的基本信息、接口请求信息和后端请求信息。

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

2. 在界面左上方选择服务网关。

3. 单击接口的名称链接，进入接口详情页面。

4. 查看接口详情。

• 基本信息：该接口所属的分组，使用的访问策略、认证策略和流量策略。

• 接口请求信息：请求协议、请求方法和请求地址。

• 请求地址为外部调用方访问网关时需要使用的地址。

• 后端请求信息：包括请求协议、请求方法、后端服务类型、超时重试策略、负载均衡算法、后端服务、默认版本、版本特性等。

• 后端服务：网关访问后端服务时需要使用的地址，为该接口默认版本对应的地址。

• 接口监控：统计一段时间内本接口的请求次数、出错次数、数据流量、调用延时和限流拦截情况。

• 接口告警：显示接口告警列表。可选择告警规则、级别、状态、或告警接口对告警进行筛选，或单击<配置告警规则>按钮配置告警规则。

• 认证信息：本接口的认证策略，包括认证类型、策略名称，AK/SK、JWT、Oauth2类型的认证策略还支持查看已订阅的凭证。

• 版本信息：该接口的版本信息和管理。

接口版本管理

新增版本

不同版本之间负载均衡策略互不影响。

 

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

2. 在界面左上方选择服务网关。

3. 单击<版本管理>按钮或者接口的名称链接，进入版本管理页面。

4. 单击<新增版本>按钮，配置版本参数。新增版本参数说明如下表：

参数	说明
后端服务	服务地址：本接口负责代理的服务提供方的IP地址/域名和端口号，格式为“主机:端口”，端口号未指定则使用默认端口。HTTP协议，默认端口号为80；HTTPS协议，默认端口号为443。单击按钮可添加多个后端服务，实现后端服务的负载均衡。 权重：当配置多个后端服务时，可以通过配置权重实现后端服务的负载均衡轮询。例如后端服务a、b的权重分别为500、200，则访问请求到a、b的比例分别为5/7、2/7。 负载均衡算法： 默认为“轮询”，即通过权重实现负载均衡。 最小连接：将请求发送给当时连接数最小的后端服务处理。 一致性哈希：需配置哈希类型和参数，系统会自动计算出hash值完成负载均衡。支持的类型包括Header、Cookie、IP。
自定义规则	自定义动态路由规则，匹配规则的请求将跳转到当前版本的后端服务地址上。默认为“关闭”，开启后可配置类型和匹配的表达式，可以添加多条规则，只需满足一条，即可匹配成功。如不匹配任何版本的规则，请求将跳转到默认版本的后端服务。 类型：Body或Header。 匹配表达式：表达式为key:value数组，当所有key:value都匹配成功时，方能表示符合该条规则，请求将跳转到当前版本的后端服务和路径。

 

5. 单击<确定>按钮，完成操作。

设为默认版本

将某版本设置为默认版本，即当请求header中不携带api-version时，默认转发的后端服务地址。

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

2. 在界面左上方选择服务网关。

3. 单击<版本管理>按钮或者接口的名称链接，进入版本管理页面。

4. 单击某版本对应的<设为默认版本>按钮，弹出确认提示框。

5. 单击<确定>按钮，完成操作。

编辑版本

修改当前版本的版本号、版本特性、后端服务、自定义规则信息。

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

2. 在界面左上方选择服务网关。

3. 单击<版本管理>按钮或者接口的名称链接，进入版本管理页面。

4. 单击某版本对应的<编辑>按钮，修改版本信息。

5. 单击<确定>按钮，完成操作。

删除版本

当不再需要使用某版本时，可执行本操作将其删除。

设置为默认的版本不允许删除。

 

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

2. 在界面左上方选择服务网关。

3. 单击<版本管理>按钮或者接口的名称链接，进入版本管理页面。

4. 单击某版本对应的<删除>按钮，弹出确认提示框。

5. 单击<确定>按钮，完成操作。

冻结/解冻接口

当接口已经被服务消费者订阅后，接口发布者可以执行本操作将某个凭证冻结/解冻，从接口方控制服务消费者的访问权限。

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

2. 在界面左上方选择服务网关。

3. 单击接口的名称链接，进入接口详情页面。

4. 单击“认证信息”页签，可以看到已订阅了本接口的凭证。

5. 单击<冻结>按钮，可限制该凭证不允许访问本接口。单击<解冻>按钮，可放开其访问权限。

上下线接口

接口上下线功能相当于接口的开关，您可以通过本功能控制接口是否生效。

下线将导致此接口无法被访问，会影响使用本接口的应用和用户，请谨慎操作。

 

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

2. 在界面左上方选择服务网关。

3. 单击待上下线的接口对应的<上线/下线>按钮，弹出操作确认窗口。

4. 单击<确定>按钮，完成操作。

编辑接口

您可以执行本操作修改接口的基本信息、接入后端服务、定义接口请求和配置策略。

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

2. 在界面左上方选择服务网关。

3. 选择待修改的接口对应的<编辑>按钮。

4. 参考发布接口修改接口的参数。

• 配置策略：如需切换策略，需先单击<解绑>按钮，解绑当前认证/访问/流控策略后，选择新策略单击<绑定>按钮，配置方可生效。

5. 单击<确定>按钮，完成操作。

删除接口

您可以执行本操作将不再使用的接口永久删除。

删除将导致此接口无法被访问，数据也将删除且无法恢复，请谨慎操作。

 

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

2. 在界面左上方选择服务网关。

3. 单击待删除的接口对应的<删除>按钮，弹出操作确认窗口。

4. 单击<确定>按钮，完成操作。

导出已发布的后端服务接口

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

2. 在界面左上方选择服务网关，界面中显示该网关下的接口列表。

3. 在右上角单击按钮，弹出“导出已发布的后端服务接口”窗口。

4. 选择所属分组，单击<确定>按钮完成操作。