Passer au contenu

Comment obtenir un identifiant d'API API Gateway et une URL d’invocation ?

Lecture de 3 minute(s)
0

Je souhaite obtenir un identifiant d’API Amazon API Gateway REST, HTTP ou WebSocket et l'URL d'invocation pour gérer mes API.

Résolution

Obtenir l'ID de l'API REST, de l'API HTTP ou de l'API WebSocket et l’URL d’invocation

Procédez comme suit :

  1. Ouvrez la console API Gateway.
  2. Dans le volet de navigation, sélectionnez API.
  3. Sélectionnez votre API REST, API HTTP ou API WebSocket.
  4. Sur la page de console API Gateway, notez l'ID de l'API. L’ID de l’API est une chaîne de caractères et de nombres, tels que chw1a2q2xk.
  5. Dans le panneau de navigation, sélectionnez Étapes.
  6. Sur la page Détails de l’étape, notez l'URL d’invocation. Les URL suivantes sont des exemples :
    API REST ou URL d'invocation HTTP : https://0123456789.execute-api.{region}.amazonaws.com/{stage-name}
    URL WebSocket : wss://{api-id}.execute-api.{region}.amazonaws.com/{stage-name}

Remarque : Si vous utilisez l’étape par défaut ($default), les URL de l'API HTTP peuvent ne pas inclure le nom de l’étape.

Utiliser l'ID de l'API pour obtenir plus d'informations sur l'API

Remarque : Si des erreurs surviennent lorsque vous exécutez des commandes de l'interface de la ligne de commande AWS (AWS CLI), consultez la section Résoudre des erreurs liées à l’AWS CLI. Vérifiez également que vous utilisez bien la version la plus récente de l'AWS CLI.

API REST

Pour obtenir le nom de l'API et la date de création de votre API REST, exécutez la commande get-rest-api suivante :

aws apigateway get-rest-api --rest-api-id your-api-id

Remarque : Remplacez your-api-id par l’ID de votre API REST.

API HTTP et API WebSocket

Pour obtenir le nom de l'API et créer une date pour votre API HTTP ou WebSocket, exécutez la commande get-api suivante :

aws apigatewayv2 get-api --api-id your-api-id

Remarque : Remplacez your-api-id par l’ID de votre API HTTP ou l’ID de votre API WebSocket.

Utiliser l'URI pour invoquer l'API

API REST et API HTTP

Remarque : Avant d'invoquer une API REST, assurez-vous de redéployer l'API REST.

Exécutez la commande curl suivante pour invoquer votre API REST ou votre API HTTP :

curl -v https://your-api-id.execute-api.your-region.amazonaws.com/your-stage-name

Remarque : Remplacez your-api-id par l’ID de votre API REST ou HTTP, your-region par votre région AWS et your-stage-name par le nom de votre étape.

API WebSocket

Remarque : Avant d'invoquer l'API WebSocket, assurez-vous de redéployer l'API WebSocket.

Exécutez la commande wscat suivante pour invoquer votre API WebSocket :

wscat -c wss://your-api-id.execute-api.your-region.amazonaws.com/your-stage-name

Remarque : Remplacez your-api-id par l’ID de votre API WebSocket, your-region par votre région et your-stage-name par le nom de votre étape.

Informations connexes

API REST API Gateway

API HTTP API Gateway

API WebSocket API Gateway

AWS OFFICIELA mis à jour il y a un an