API Gateway API ID を取得して URL を呼び出す方法を教えてください。

解決策

REST API、HTTP API、WebSocket API のいずれかの ID を取得して URL を呼び出します

次の手順を実行します。

1. API Gateway コンソールを開きます。
2. ナビゲーションペインで [API] を選択します。
3. REST API、HTTP API、またはウェブソケット API を選択してください。
4. API Gateway コンソールページで、API ID をメモします。API ID は、chw1a2q2xk などの文字列と数字です。
5. ナビゲーションペインで [ステージ] を選択します。
6. [ステージの詳細] ページで、呼び出し URL をメモします。次の URL は例です。
   REST API または HTTP 呼び出し URL: https://0123456789.execute-api.{region}.amazonaws.com/{stage-name}
   WebSocket URL: wss://{api-id}.execute-api.{region}.amazonaws.com/{stage-name}

注: デフォルトステージ ($default) を使用する場合、HTTP API URL にステージ名が含まれていない可能性があります。

API ID を使用して API に関する詳細情報を取得する

注: AWS コマンドラインインターフェイス (AWS CLI) コマンドの実行中にエラーが発生した場合は、「AWS CLI で発生したエラーのトラブルシューティング」を参照してください。また、AWS CLI の最新バージョンを使用していることを確認してください。

REST API

REST API の API 名と作成日を取得するには、次の get-rest-api コマンドを実行します。

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

注: your-api-id を実際の REST API ID に置き換えてください。

HTTP API と WebSocket API

HTTP API または WebSocket API の API 名と作成日を取得するには、次の get-api コマンドを実行します。

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

注: your-api-id を実際の HTTP API ID または WebSocket API ID に置き換えてください。

URI を使用して API を呼び出す

**REST API と HTTP API **

注: REST API を呼び出す前に、必ず REST API を再デプロイしてください。

次の curl コマンドを実行して REST API または HTTP API を呼び出します。

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

注: your-api-id を実際の REST API または HTTP API ID に、your-region を実際の AWS リージョンに、your-stage-name を実際のステージ名にそれぞれ置き換えます。

WebSocket API

注: WebSocket API を呼び出す前に、必ず WebSocket API を再デプロイしてください。

次の wscat コマンドを実行して WebSocket API を呼び出します。

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

注: **your-api-id ** を実際の WebSocket API ID に、your-region を実際のリージョンに、your-stage-name をステージ名にそれぞれ置き換えます。

関連情報

API Gateway REST API

API Gateway HTTP API

API Gateway WebSocket API