我想要取得 Amazon API Gateway 的 REST、HTTP 或 WebSocket API ID,以及調用網址,以管理我的 API。
解決方法
取得 REST API、HTTP API 或 WebSocket API ID 與調用網址
請完成以下步驟:
- 開啟 API Gateway console (API Gateway 主控台)。
- 在導覽窗格中,選擇 API。
- 選取您的 REST API、HTTP API 或 WebSocket API。
- 在 API Gateway 主控台頁面上,記下 API ID。API ID 是由字元與數字組成的字串,例如 chw1a2q2xk。
- 在導覽窗格中,選擇 Stages (階段)。
- 在 Stage details (階段詳細資料) 頁面上,記下調用網址。以下為網址範例:
REST API 或 HTTP 調用網址:https://0123456789.execute-api.{region}.amazonaws.com/{stage-name}
WebSocket 網址:wss://{api-id}.execute-api.{region}.amazonaws.com/{stage-name}
**注意:**如果您使用預設階段 ($default),HTTP API 網址可能不包含階段名稱。
使用 API ID 以取得 API 的更多資訊
**注意:**如果您在執行 AWS Command Line Interface (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 APIs and 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 and 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