文档中心>微服务引擎 TSE>云原生 API 网关>快速入门>使用云原生 API 网关实现 WebSocket 服务转发

使用云原生 API 网关实现 WebSocket 服务转发

最近更新时间:2024-04-26 16:09:21

我的收藏
WebSocket 的服务可以按照正常的 HTTP(HTTPS)服务配置,只要访问网关的时候使用 WebSocket 的协议,网关会自动升级协议为 WebSocket ,用户不需要明确指定协议为 WebSocket。本文将快速引导您如何在云原生 API 网关中,访问后端服务为 WebSocket 类型的 API。

操作步骤

步骤1:创建云原生 API 网关实例

参见 新建网关,创建一个云原生 API 网关。

步骤2:定义后端服务信息

1. 单击创建好的网关实例的“ID”,进入实例详情页。
2. 在顶部菜单栏选择路由管理 > 服务,在服务列表单击新建
3. 在新建服务窗口中配置相关参数后,单击提交
说明:
新建网关服务,如果后端服务 WebSocket 提供的是 WS 协议,选择服务协议为 HTTP,如果后端服务提供的是 WSS 协议,选择服务协议为 HTTPS。服务的类型也可以为 K8S 服务/ IP列表等。




步骤3:为后端服务配置路由

1. 后端服务添加完成后,点击后端服务名称进入路由管理页面。
2. 单击新建,设置好路由信息,单击下一步
说明:
请求方法、请求路径、Host 需至少配置一种。



3. 配置路由后端信息,确认后端服务信息无误后单击提交,完成路由创建。




步骤4:访问 WebSocket 服务

1. 进入云原生 API 网关的基本信息页面,获取负载均衡地址。



2. 使用负载均衡地址和配置的路由路径访问 API。
使用 WS 协议访问网关:websocat ws://<网关负载均衡IP或域名>/websocket。
使用 WSS 协议访问网关:websocat wss://<网关负载均衡IP或域名>/websocket -k。