# 使用 AWS CLI 的 API Gateway Management API 示例
<a name="cli_apigatewaymanagementapi_code_examples"></a>

以下代码示例演示如何通过将 AWS Command Line Interface与 API Gateway Management API 结合使用，来执行操作和实现常见场景。

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

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

**Topics**
+ [操作](#actions)

## 操作
<a name="actions"></a>

### `delete-connection`
<a name="apigatewaymanagementapi_DeleteConnection_cli_topic"></a>

以下代码示例演示了如何使用 `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 命令](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/delete-connection.html)。

### `get-connection`
<a name="apigatewaymanagementapi_GetConnection_cli_topic"></a>

以下代码示例演示了如何使用 `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 命令](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/get-connection.html)。

### `post-to-connection`
<a name="apigatewaymanagementapi_PostToConnection_cli_topic"></a>

以下代码示例演示了如何使用 `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 命令](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [PostToConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/post-to-connection.html)。