API使用网关管理API示例 AWS CLI - AWS Command Line Interface
操作

本文档 AWS CLI 仅适用于版本 1。有关版本 2 的文档 AWS CLI，请参阅版本 2 用户指南。

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

API使用网关管理API示例 AWS CLI

以下代码示例向您展示了如何通过 AWS Command Line Interface 与API网关管理一起使用来执行操作和实现常见场景API。

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

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

主题

操作

以下代码示例显示了如何使用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 命令。

以下代码示例显示了如何使用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 命令。

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

AWS CLI

向 WebSocket 连接发送数据

以下post-to-connection示例向连接到指定的 Client 端发送一条消息 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 命令。