Tous les produits
Search
Centre de documentation

API Gateway:Create a WebSocket API

Dernière mise à jour :Sep 21, 2026

Les API WebSocket permettent une communication bidirectionnelle entre les clients et les serveurs, ce qui les rend idéales pour les applications en temps réel telles que la messagerie instantanée, les notifications et les jeux. Créez une API WebSocket dans la console Cloud-native API Gateway.

Cas d'utilisation

Vous pouvez créer des API au sein d'une instance ou en dehors de celle-ci, selon vos besoins.

Créer une API au sein d'une instance

  • Gestion dédiée des ressources : l'API gère les ressources ou la logique interne uniquement au sein d'une instance spécifique.

  • Sécurité et isolation : les données ou les fonctionnalités nécessitent une isolation stricte et ne sont appelables qu'à partir de l'instance.

  • Configuration simplifiée du service : le fait de limiter la configuration à une instance spécifique simplifie la gestion des API.

Créer une API en dehors d'une instance

  • Accès partagé inter-instances : plusieurs instances partagent une seule définition d'API.

  • Gestion et surveillance centralisées : contrôle unifié des autorisations, journalisation et gestion du trafic.

Important
  • Les API créées au sein d'une instance sont visibles et peuvent être gérées uniquement dans cette instance.

  • Les API créées en dehors d'une instance ne peuvent pas être modifiées ni supprimées depuis l'instance. Vous devez les gérer à partir de la liste des API externes.

Procédure

  1. Créez des API au sein d'une instance ou en dehors de celle-ci :

    En dehors d'une instance

    1. Connectez-vous à la console Cloud-native API Gateway. Dans le volet de navigation de gauche, sélectionnez API, puis sélectionnez une région dans la barre de menu supérieure.

    2. Cliquez sur Create API, puis cliquez sur Create sur la carte WebSocket API.

    Au sein d'une instance

    1. Connectez-vous à la console Cloud-native API Gateway. Dans le volet de navigation de gauche, sélectionnez Instance, puis sélectionnez une région dans la barre de menu supérieure.

    2. Sur la page Instance, cliquez sur l'ID de l'instance cible. Dans le volet de navigation de gauche, sélectionnez API, puis cliquez sur Create API dans le coin supérieur droit.

    3. Sur la carte WebSocket API, cliquez sur Create.

  2. Sur la page de création de l'API WebSocket, saisissez un nom d'API Name et une Description, puis sélectionnez une resource cible.

    Parameter

    Description

    API Name

    Spécifiez un nom globalement unique pour l'API.

    Description

    Saisissez une description pour l'API.

    resource

    Sélectionnez un groupe de ressources. Cliquez sur Create Resource Group à droite pour en créer un.