生命周期事件 - AWS IoT

生命周期事件

AWS IoT 在以下各部分中讨论的 MQTT 主题下发布生命周期事件。借助这些消息,您可以接收消息代理发出的生命周期事件通知。

注意

生命周期消息可能不会按顺序发送。您可能会收到重复的消息。

连接/断开连接事件

AWS IoT 在客户端建立连接或断开连接时将消息发布到以下 MQTT 主题:

  • $aws/events/presence/connected/clientId – 连接到消息代理的客户端。

  • $aws/events/presence/disconnected/clientId – 与消息代理断开连接的客户端。

下面是一系列 JSON 元素,发布到 $aws/events/presence/connected/clientId 主题的连接/断开连接消息中包含这些元素。

clientId

建立连接或断开连接的客户端的 ID。

注意

包含 # 或 + 的客户端 ID 不接收生命周期事件。

clientInitiatedDisconnect

如果客户端启动断开连接,则为“True”。否则为 false。只能在断开连接消息中找到。

disconnectReason

客户端断开连接的原因。只能在断开连接消息中找到。下表包含有效值。

断开连接原因 描述
AUTH_ERROR 客户端无法进行身份验证或授权失败。
CLIENT_INITIATED_DISCONNECT 客户端指示它将断开连接。客户端可以通过发送 MQTT DISCONNECT 控制数据包或 Close frame(如果客户端使用的是 WebSocket 连接)来执行此操作。
CLIENT_ERROR 客户端出错,导致它断开连接。例如,如果客户端在同一连接上发送多个 MQTT CONNECT 数据包,或者客户端尝试使用超过负载限制的负载进行发布,则将断开连接。
CONNECTION_LOST 客户端-服务器连接被切断。在高网络延迟期间或互联网连接断开时,可能会发生此情况。
DUPLICATE_CLIENTID 客户端使用的是已在使用的客户端 ID。在这种情况下,已连接的客户端将因这一断开连接原因而断开连接。
FORBIDDEN_ACCESS 不允许连接客户端。例如,IP 地址被拒绝的客户端将无法连接。
MQTT_KEEP_ALIVE_TIMEOUT 如果在 1.5 倍的客户端保持连接时间内没有客户端-服务器通信,则客户端将断开连接。
SERVER_ERROR 由于意外的服务器问题而断开连接。
SERVER_INITIATED_DISCONNECT 服务器出于操作原因而故意断开与客户端的连接。
THROTTLED 客户端由于超出限制而断开连接。
WEBSOCKET_TTL_EXPIRATION 由于 WebSocket 的连接时间超过其生存时间值,客户端断开连接。
eventType

事件类型。有效值为 connecteddisconnected

ipAddress

连接客户端的 IP 地址。该地址可以采用 IPv4 或 IPv6 格式。只能在连接消息中找到。

principalIdentifier

用于执行身份验证的凭证。对于 TLS 双向身份验证证书,这是证书 ID。对于其他连接,这是 IAM 凭证。

sessionIdentifier

AWS IoT 中的全局唯一标识符,在会话持续时间内存在。

timestamp

大致的事件发生时间,使用自 Unix 纪元时间以来的毫秒数表示。时间戳的准确度是 +/- 2 分钟。

versionNumber

生命周期事件的版本号。对于每个客户端 ID 连接,这是一个单调递增的长整数值。订阅者可以使用版本号来推断生命周期事件的顺序。

注意

客户端连接的连接和断开消息具有相同的版本号。

版本号可能会跳过值,而不保证对于每个事件始终增加 1。

如果客户端约一小时未连接,则版本号将重置为 0。对于持久性会话,在客户端断开连接的时间超过为持久性会话配置的生存时间 (TTL) 后,版本号将重置为 0。

连接消息具有以下结构。

{ "clientId": "186b5", "timestamp": 1573002230757, "eventType": "connected", "sessionIdentifier": "a4666d2a7d844ae4ac5d7b38c9cb7967", "principalIdentifier": "12345678901234567890123456789012", "ipAddress": "192.0.2.0", "versionNumber": 0 }

断开连接消息具有以下结构。

{ "clientId": "186b5", "timestamp": 1573002340451, "eventType": "disconnected", "sessionIdentifier": "a4666d2a7d844ae4ac5d7b38c9cb7967", "principalIdentifier": "12345678901234567890123456789012", "clientInitiatedDisconnect": true, "disconnectReason": "CLIENT_INITIATED_DISCONNECT", "versionNumber": 0 }

处理客户端断开连接

最佳实践是始终为生命周期事件实现等待状态,包括 Last Will and Testament (LWT) 消息。收到断开连接消息后,您的代码应等待一段时间,并在采取措施之前验证设备是否仍处于脱机状态。实现此目标的一种方法是使用 SQS 延迟队列。当客户端收到 LWT 或生命周期事件时,您可以将消息列入队列进行排队(例如 5 秒)。当消息可用并被处理(通过 Lambda 或其他服务)时,您可以先检查设备是否仍处于脱机状态,然后再采取进一步措施。

订阅/取消订阅事件

当客户端订阅或取消订阅 MQTT 主题时,AWS IoT 将向以下 MQTT 主题发布消息:

$aws/events/subscriptions/subscribed/clientId

$aws/events/subscriptions/unsubscribed/clientId

其中 clientId 是连接到 AWS IoT 消息代理的 MQTT 客户端 ID。

发布到该主题的消息具有以下结构:

{ "clientId": "186b5", "timestamp": 1460065214626, "eventType": "subscribed" | "unsubscribed", "sessionIdentifier": "00000000-0000-0000-0000-000000000000", "principalIdentifier": "000000000000/ABCDEFGHIJKLMNOPQRSTU:some-user/ABCDEFGHIJKLMNOPQRSTU:some-user", "topics" : ["foo/bar","device/data","dog/cat"] }

下面是一系列 JSON 元素,发布到 $aws/events/subscriptions/subscribed/clientId$aws/events/subscriptions/unsubscribed/clientId 主题的已订阅/未订阅消息中包含这些元素。

clientId

订阅或取消订阅的客户端的 ID。

注意

包含 # 或 + 的客户端 ID 不接收生命周期事件。

eventType

事件类型。有效值为 subscribedunsubscribed

principalIdentifier

用于执行身份验证的凭证。对于 TLS 双向身份验证证书,这是证书 ID。对于其他连接,这是 IAM 凭证。

sessionIdentifier

AWS IoT 中的全局唯一标识符,在会话持续时间内存在。

timestamp

大致的事件发生时间,使用自 Unix 纪元时间以来的毫秒数表示。时间戳的准确度是 +/- 2 分钟。

topics

客户端已订阅的一系列 MQTT 主题。

注意

生命周期消息可能不会按顺序发送。您可能会收到重复的消息。