使用 AWS CLI 的 API Gateway Management API 範例 - AWS Command Line Interface
動作

使用 AWS CLI 的 API Gateway Management API 範例

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 API Gateway Management API 來執行動作，並實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例均包含完整原始程式碼的連結，您可在連結中找到如何在內容中設定和執行程式碼的相關指示。

主題

動作

以下程式碼範例顯示如何使用 delete-connection。

AWS CLI

刪除 WebSocket 連線

下列 delete-connection 範例會中斷用戶端與指定 WebSocket API 的連線。

aws apigatewaymanagementapi delete-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon API Gateway 開發人員指南》中的在後端服務中使用 @connections 命令。

  • 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteConnection。

以下程式碼範例顯示如何使用 get-connection。

AWS CLI

取得 WebSocket 連線的相關資訊

下列 get-connection 範例會描述與指定 WebSocket API 的連線。

aws apigatewaymanagementapi get-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

輸出：

{
    "ConnectedAt": "2020-04-30T20:10:33.236Z",
    "Identity": {
        "SourceIp": "192.0.2.1"
    },
    "LastActiveAt": "2020-04-30T20:10:42.997Z"
}

如需詳細資訊，請參閱《Amazon API Gateway 開發人員指南》中的在後端服務中使用 @connections 命令。

  • 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetConnection。

以下程式碼範例顯示如何使用 post-to-connection。

AWS CLI

將資料傳送至 WebSocket 連線

下列 post-to-connection 範例會將訊息傳送至與指定 WebSocket API 連線的用戶端。

aws apigatewaymanagementapi post-to-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --data "Hello from API Gateway!" \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon API Gateway 開發人員指南》中的在後端服務中使用 @connections 命令。

  • 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 PostToConnection。