API Gateway 管理 API 示例使用 Amazon CLI - Amazon Command Line Interface
操作
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

API Gateway 管理 API 示例使用 Amazon CLI

以下代码示例向您展示了如何使用 with API Gateway Management API 来执行操作和实现常见场景。 Amazon Command Line Interface

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景和跨服务示例的上下文查看操作。

场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。

每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

以下代码示例演示如何使用 delete-connection。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考DeleteConnection中的。

以下代码示例演示如何使用 get-connection。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考GetConnection中的。

以下代码示例演示如何使用 post-to-connection。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考PostToConnection中的。