创建WebSocket API

WebSocket API基于WebSocket协议,允许客户端和服务器之间进行双向通信,是构建实时应用(如聊天、实时通知、游戏等)的理想选择。本文将指导您如何通过控制台创建WebSocket API。

适用场景

云原生API网关提供了实例内和实例外两种创建API的方式,分别适用以下场景:

实例内创建API

  • 资源的专用管理:API仅需在特定实例内使用,管理特定资源或内部逻辑。

  • 安全性和隔离性:数据或功能需要严格隔离以确保安全性,仅在实例内调用。

  • 简化服务配置:简化在特定实例中的API配置和管理。

实例外创建API

  • 跨实例共享访问:多个实例共享 API 定义信息。

  • 集中管理和监控:统一权限控制、日志记录和流量管理。

重要
  • 实例内创建的API仅在对应实例中可见并管理。

  • 实例外创建的API不支持在实例内进行编辑和删除,需要前往实例外API列表中操作。

操作步骤

  1. 云原生API网关提供了实例内和实例外两种创建API的方式:

    实例外API

    1. 登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。

    2. 单击创建API,然后单击WebSocket API卡片中的创建。

    实例内API

    1. 登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。

    2. 实例页面,单击目标网关实例ID。左侧导航栏选择API,单击右上角创建API

    3. 单击WebSocket API卡片中的创建

  2. 在创建WebSocket API页面填写API名称描述,并选择目标资源组

    配置项

    说明

    API名称

    自定义创建的API名称,API名称需要全局唯一。

    描述

    填写API相关的描述。

    资源组

    选择目标资源组。您可单击右侧的创建资源组