選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料,以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用,但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意,AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定,並顯示相關內容,包括相關廣告。若要接受或拒絕所有非必要 Cookie,請按一下「接受」或「拒絕」。若要進行更詳細的選擇,請按一下「自訂」。

使用 的 API Gateway Management API 範例 AWS CLI

焦點模式
使用 的 API Gateway Management API 範例 AWS CLI - AWS Command Line Interface

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

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

下列程式碼範例示範如何使用 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

下列程式碼範例示範如何使用 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

下列程式碼範例示範如何使用 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

下列程式碼範例示範如何使用 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

在本頁面

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。