使用 API Gateway 管理 API 範例 AWS CLI - AWS SDK 程式碼範例
動作

文件 AWS SDK AWS 範例 SDK 儲存庫中有更多可用的 GitHub 範例。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 API Gateway 管理 API 範例 AWS CLI

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

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

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

主題

動作

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

AWS CLI

若要刪除 a WebSocket 連線

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

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

取得 a WebSocket 連線的相關資訊

下列get-connection範例說明與指定 WebSocket APIWord 的連線。

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

將資料傳送至 a WebSocket 連線

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

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。