保留的主题 - AWS IoT Core

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

保留的主题

以美元符号 ($) 开头的主题保留供使用 AWS IoT。您可以在允许的情况下订阅和发布到这些保留的主题;但是,您不能创建以美元符号开头的新主题。对保留的主题执行不受支持的发布或订阅操作可能会导致连接终止。

资产模型主题

主题 允许的客户端操作 描述

$ aws/sitewise/asset-models/ /assetsassetModelId//properties/ assetId propertyId

Subscribe

AWS IoT SiteWise 向该主题发布资产属性通知。有关更多信息,请参阅《AWS IoT SiteWise 用户指南》中的与其他 AWS 服务交互

AWS IoT Device Defender 话题

这些消息支持简明二进制对象表示 (CBOR) 格式和 JavaScript 对象表示法 (JSON) 的响应缓冲区,具体取决于主题。payload-format AWS IoT Device Defender 仅主题支持MQTT发布。

payload-format 响应格式数据类型
cbor 简洁的二进制对象表示 (CBOR)
json JavaScript 物体标记 (JSON)

有关更多信息,请参阅从设备发送指标

主题 允许的操作 描述

$aw thingName s/things/ /defender/metrics/ payload-format

发布

AWS IoT Device Defender 代理向该主题发布指标。有关更多信息,请参阅从设备发送指标

$aws/things/ /defender/metrics//thingName已接受 payload-format

Subscribe

AWS IoT 在 AWS IoT Device Defender 代理成功向 $aws/things/ /defender/ thingName metrics/ 发布消息后,向该主题发布消息。payload-format有关更多信息,请参阅从设备发送指标

$aws/things/ /defender/metrics//thingName被拒绝 payload-format

Subscribe

AWS IoT 在 AWS IoT Device Defender 代理向 $aws/things/ /defender/ thingName metrics/ 发布一条失败的消息后,向该主题发布消息。payload-format有关更多信息,请参阅从设备发送指标

AWS IoT Core 设备位置主题

AWS IoT Core 设备位置可以解析来自您设备的测量数据,并提供物联网设备的估计位置。来自设备的测量数据可能包括 Wi-Fi GNSS、蜂窝和 IP 地址。 AWS IoT Core 然后,Device Location 会选择能够提供最佳精度并求解设备位置信息的测量类型。有关更多信息,请参阅AWS IoT Core 设备位置使用 AWS IoT Core 设备位置 MQTT 主题解析设备位置

主题 允许的操作 描述

$aw customer_device_id s/device_location/ /get_position_

发布

设备向本主题发布信息,以获取扫描的原始测量数据,以便通过 “ AWS IoT Core 设备位置” 进行解析。

$aw customer_device_id s/device_location/ /get_position_estimat

Subscribe

AWS IoT Core 成功解析设备位置后,设备位置将发布到此主题中。

$aw customer_device_id s/device_location/ /get_position_estimat

Subscribe

AWS IoT Core 当 “设备位置” 因 4xx 错误而无法成功解析设备位置时,它会发布到此主题中。

事件主题

在发生特定事件时将发布事件消息。例如,在添加、更新或删除事物时,由注册表生成事件。该表显示了各种 AWS IoT 活动及其保留的主题。

主题 允许的客户端操作 描述

$aws/events/certificates/registered/caCertificateId

Subscribe

AWS IoT 当 AWS IoT 自动注册证书以及客户端出示带有PENDING_ACTIVATION状态的证书时,会发布此消息。有关更多信息,请参阅 配置客户端的首次连接以进行自动注册

$aws/events/job/jobID/已取消

Subscribe

AWS IoT 取消任务时会发布此消息。有关更多信息,请参阅 任务事件
$aws/events/job/jobID/取消正在进行中

Subscribe

AWS IoT 在取消任务时发布此消息。有关更多信息,请参阅 任务事件

$aws/events/job/jobID/已完成

Subscribe

AWS IoT 任务完成后发布此消息。有关更多信息,请参阅 任务事件
$aws/events/job/jobID/已删除

Subscribe

AWS IoT 删除作业时会发布此消息。有关更多信息,请参阅 任务事件
$aws/events/job/jobID/deletion_in_progress

Subscribe

AWS IoT 删除任务时会发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/已取消

Subscribe

AWS IoT 取消任务执行时会发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/已删除

Subscribe

AWS IoT 删除任务执行时会发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/failed

Subscribe

AWS IoT 任务执行失败时发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/已拒绝

Subscribe

AWS IoT 在任务执行被拒绝时发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/已移除

Subscribe

AWS IoT 删除任务执行时会发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/成功了

Subscribe

AWS IoT 任务执行成功后发布此消息。有关更多信息,请参阅 任务事件
$aws/events/jobExecution/jobID/timed_out

Subscribe

AWS IoT 在任务执行超时时时发布此消息。有关更多信息,请参阅 任务事件

$aws/events/presence/connected/clientId

Subscribe

AWS IoT 当具有指定客户端 ID 的MQTT客户端连接到时,将发布到此主题 AWS IoT。有关更多信息,请参阅 连接/断开连接事件

$aws/events/presence/disconnected/clientId

Subscribe

AWS IoT 当具有指定客户端 ID 的MQTT客户端断开与该主题的连接时,将发布到 AWS IoT此主题。有关更多信息,请参阅 连接/断开连接事件

$aws/events/subscriptions/subscribed/clientId

Subscribe

AWS IoT 当具有指定客户端 ID 的MQTT客户订阅主题时,将发布到此MQTT主题。有关更多信息,请参阅 订阅/取消订阅事件

$aws/events/subscriptions/unsubscribed/clientId

Subscribe

AWS IoT 当具有指定客户端 ID 的MQTT客户取消订阅某个MQTT主题时,将发布到该主题。有关更多信息,请参阅 订阅/取消订阅事件

$aws/events/thing/thingName/created

Subscribe

AWS IoT 在创建thingName事物时向该主题发布。有关更多信息,请参阅 注册表事件

$aws/events/thing/thingName/已更新

Subscribe

AWS IoT thingName事物更新时向该主题发布。有关更多信息,请参阅 注册表事件

$aws/events/thing/thingName/已删除

Subscribe

AWS IoT 删除thingName事物后,将发布到此主题。有关更多信息,请参阅 注册表事件

$aws/events/thingGroup/thingGroupName/created

Subscribe

AWS IoT 在创建事物组thingGroupName时向该主题发布内容。有关更多信息,请参阅 注册表事件

$aws/events/thingGroup/thingGroupName/已更新

Subscribe

AWS IoT 事物组thingGroupName更新后,向该主题发布内容。有关更多信息,请参阅 注册表事件

$aws/events/thingGroup/thingGroupName/已删除

Subscribe

AWS IoT 删除事物组thingGroupName后,向该主题发布内容。有关更多信息,请参阅 注册表事件

$aws/events/thingType/thingTypeName/created

Subscribe

AWS IoT 在创建thingTypeName事物类型时向该主题发布。有关更多信息,请参阅 注册表事件

$aws/events/thingType/thingTypeName/已更新

Subscribe

AWS IoT 在thingTypeName事物类型更新时向该主题发布。有关更多信息,请参阅 注册表事件

$aws/events/thingType/thingTypeName/已删除

Subscribe

AWS IoT 删除thingTypeName事物类型后,将发布到该主题。有关更多信息,请参阅 注册表事件

$aws/events/thingTypeAssociation/thing/thingName/thingTypeName

Subscribe

AWS IoT 当事物与事物类型关联或与事物thingName类型thingTypeName取消关联时,发布到此主题。有关更多信息,请参阅 注册表事件

$aws/events/thingGroupMembership/thingGroup//t thingGroupName hing/ /add thingName ed

Subscribe

AWS IoT 将事物添加到事物thingName组时发布到此主题thingGroupName。有关更多信息,请参阅 注册表事件

$aws/events/thingGroupMembership/thingGroup//t thingGroupName hing//thingName已移除

Subscribe

AWS IoT 将事物从事物thingName组中移除后发布到此主题thingGroupName。有关更多信息,请参阅 注册表事件

$aws/events/thingGroupHierarchy/thingGroup//parentThingGroupNamechildThingGroup///已添childThingGroupName

Subscribe

AWS IoT 将事物组添加到事物组后childThingGroupName,将发布到该主题parentThingGroupName。有关更多信息,请参阅 注册表事件

$aws/events/thingGroupHierarchy/thingGroup//parentThingGroupNamechildThingGroup///已移childThingGroupName

Subscribe

AWS IoT 将事物组从事物组childThingGroupName中移除后发布到此主题parentThingGroupName。有关更多信息,请参阅 注册表事件

队列预置主题

注意

此表中标为 R eceive 的客户端操作表示直接向请求它的客户端 AWS IoT 发布的主题,无论该客户是否订阅了该主题。即使客户端尚未订阅这些消息,也会收到这些消息。这些响应消息不会通过消息代理,也无法由其它客户端或规则订阅。

这些消息支持简明二进制对象表示 (CBOR) 格式和 JavaScript 对象表示法 (JSON) 的响应缓冲区,具体取决于主题。payload-format

payload-format 响应格式数据类型
cbor 简洁的二进制对象表示 (CBOR)
json JavaScript 物体标记 (JSON)

有关更多信息,请参阅 设备预调配 MQTT API

主题 允许的客户端操作 描述

$aws/certificates/create/payload-format

发布

发布到本主题以根据证书签名请求创建证书(CSR)。

$aws/certificates/create/payload-format/已接受

订阅,接收

AWS IoT 成功调用 $aws/certificates/create/后发布到此主题payload-format

$aws/certificates/create/payload-format/已拒绝

订阅,接收

AWS IoT 在调用 $aws/certificates/create/失败后发布到此主题payload-format

$ aws/certificates/create-from-csr/ payload-format

发布

向本主题发布内容以从创建证书CSR。

$ aws/certificates/create-from-csr/ //accep payload-format ted

订阅,接收

AWS IoT 向此主题发布对 $ aws/certificates/create-from-payload-format csr/ 的成功调用。

$ aws/certificates/create-from-csr///payload-format已拒绝

订阅,接收

AWS IoT 向此主题发布了对 $ aws/certificates/create-from-payload-format csr/ 的调用失败。

$aw templateName s/provisioning-templatess//payload-format

发布

发布到此主题以注册事物。

$aws/provision-templates/ //provis templateName ion payload-format

订阅,接收

AWS IoT 在成功调用 $aws/provisioning-templates//templateNameprovision/ 后发布到此主题。payload-format

$aws/provisioning-templates////templateName已拒绝 payload-format

订阅,接收

AWS IoT 在调用 $aws/provisioning-templates//templateNameprovision/ 失败后发布到此主题。payload-format

任务主题

注意

此表中标为 R eceive 的客户端操作表示直接向请求它的客户端 AWS IoT 发布的主题,无论该客户是否订阅了该主题。即使客户端尚未订阅这些消息,也会收到这些消息。

这些响应消息不会通过消息代理,也无法由其它客户端或规则订阅。要订阅与工作活动消息相关的任务活动,请使用 notifynotify-next 主题。

当订阅任务和您的机群监控解决方案的 jobExecution 事件主题时,您必须首先启用任务和任务执行事件接收云端的任何事件。

有关更多信息,请参阅 作业设备MQTTAPI操作

主题 允许的客户端操作 描述

$aw thingName s/things/ /jobs/get

发布

设备向此主题发布一条消息以发出 GetPendingJobExecutions 请求。有关更多信息,请参阅 作业设备MQTTAPI操作

$aw thingName s/things//jobs/get/accepted

订阅,接收

设备订阅此主题以接收来自 GetPendingJobExecutions 请求的成功响应。有关更多信息,请参阅 作业设备MQTTAPI操作

$aw thingName s/things//jobs/get/rejected

订阅,接收

GetPendingJobExecutions 请求被拒绝时,设备会订阅此主题以接收响应。有关更多信息,请参阅 作业设备MQTTAPI操作

$aw thingName s/things/ /jobs/start-nex

发布

设备向此主题发布一条消息以发出 StartNextPendingJobExecution 请求。有关更多信息,请参阅 作业设备MQTTAPI操作

$aw thingName s/things//jobs/start-next/accepted

订阅,接收

设备订阅此主题以接收 StartNextPendingJobExecution 请求的成功响应。有关更多信息,请参阅 作业设备MQTTAPI操作

$aw thingName s/things//jobs/start-next/rejected

订阅,接收

StartNextPendingJobExecution 请求被拒绝时,设备会订阅此主题以接收响应。有关更多信息,请参阅 作业设备MQTTAPI操作

$aws/things/ /jobs/ /g thingName et jobId

发布

设备向此主题发布一条消息以发出 DescribeJobExecution 请求。有关更多信息,请参阅 作业设备MQTTAPI操作

$aws/things/ /jobs/ /get/acc thingName ept jobId

订阅,接收

设备订阅此主题以接收 DescribeJobExecution 请求的成功响应。有关更多信息,请参阅 作业设备MQTTAPI操作

$aws/things/ /jobs/ /get/rec thingName tion jobId

订阅,接收

DescribeJobExecution 请求被拒绝时,设备会订阅此主题以接收响应。有关更多信息,请参阅 作业设备MQTTAPI操作

$aws/things/ /jobs/ /更新 thingName jobId

发布

设备向此主题发布一条消息以发出 UpdateJobExecution 请求。有关更多信息,请参阅 作业设备MQTTAPI操作

$aws/things/ /jobs/ /更新/ thingName 已接受 jobId

订阅,接收

设备订阅此主题以接收 UpdateJobExecution 请求的成功响应。有关更多信息,请参阅 作业设备MQTTAPI操作

注意

只有发布到 $aws/things//thingNamejobs/ /update 的设备才会收到有关此主题的jobId消息。

$aws/things/ /jobs/ /update/ thingName 已拒绝 jobId

订阅,接收

UpdateJobExecution 请求被拒绝时,设备会订阅此主题以接收响应。有关更多信息,请参阅 作业设备MQTTAPI操作

注意

只有发布到 $aws/things//thingNamejobs/ /update 的设备才会收到有关此主题的jobId消息。

$aw thingName s/things//jobs/noti

订阅,接收

设备订阅此主题,以在某个事物的待处理执行列表中添加或删除了任务执行时接收通知。有关更多信息,请参阅 作业设备MQTTAPI操作

$aw thingName s/things/ /jobs/notify-nex

订阅,接收

设备订阅此主题,以在事物的下一个待处理任务执行发生更改时接收通知。有关更多信息,请参阅 作业设备MQTTAPI操作

$aws/events/job/jobId/已完成

Subscribe

当某个任务完成时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/job/jobId/已取消

Subscribe

当取消某个任务时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/job/jobId/已删除

Subscribe

当删除某个任务时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/job/jobId/取消正在进行中

Subscribe

当开始取消某个任务时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/job/jobId/deletion_in_progress

Subscribe

当开始删除某个任务时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/jobExecution/jobId/成功了

Subscribe

当任务执行成功时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/jobExecution/jobId/failed

Subscribe

当任务执行失败时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/jobExecution/jobId/已拒绝

Subscribe

当任务执行被拒绝时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/jobExecution/jobId/已取消

Subscribe

当任务执行取消时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/jobExecution/jobId/timed_out

Subscribe

当任务执行超时时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/jobExecution/jobId/已移除

Subscribe

当任务执行被移除时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

$aws/events/jobExecution/jobId/已删除

Subscribe

当任务执行被删除时,任务服务在此主题上发布事件。有关更多信息,请参阅 任务事件

命令主题

注意

此表中标为 R eceive 的客户端操作表示直接向请求它的客户端 AWS IoT 发布的主题,无论该客户是否订阅了该主题。即使客户端尚未订阅这些消息,也会收到这些消息。

这些响应消息不会通过消息代理,也无法由其它客户端或规则订阅。

主题 允许的客户端操作 描述

$aws/commands/ //executions/ /requ <devices> est/ <DeviceID> <ExecutionId> <PayloadFormat>

$aws/commands/ //executions/ /reques <devices> <DeviceID> <ExecutionId>

订阅,接收

当有人请求从控制台或使用开始执行命令时,设备会收到有关此主题的消息StartCommandExecutionAPI。在这种情况下,<devices>可以是物联网事物或MQTT客户端,<DeviceID>可以是物联网事物的名称或MQTT客户端 ID。

$aws/commands/ //executions/ /respons <devices> e/ <DeviceID> <ExecutionId> <PayloadFormat>

发布

设备使用UpdateCommandExecutionMQTTAPI向本主题发布有关命令执行的消息。该消息是作为对从控制台或使用开始执行命令的请求的响应发布的StartCommandExecutionAPI。已发布的消息将使用JSON或CBOR作为<PayloadFormat>

$aws/commands/ //exections/ /respons <devices> e/ /已接受 <DeviceID> <ExecutionId> <PayloadFormat>

$aws/commands/ //exections/ /respons <devices> e/acce <DeviceID> <ExecutionId>

订阅,接收

如果云服务成功处理了命令执行结果,则会 AWS IoT Device Management 发布对 /accepted 主题的响应。

$aws/commands/ //executions/ /respons <devices> e/ /已拒绝 <DeviceID> <ExecutionId> <PayloadFormat>

$aws/commands/ //executions/ /response/已拒绝 <devices> <DeviceID> <ExecutionId>

发布

如果云服务未能处理命令执行结果,则会 AWS IoT Device Management 发布对 /recjected 主题的响应。

规则主题

主题 允许的客户端操作 描述

$aws/rules/ ruleName

发布

设备或应用程序向此主题发布消息以直接触发规则。有关更多信息,请参阅 借助基本摄取功能,降低消息收发成本

安全隧道主题

主题 允许的客户端操作 描述

$aw thing-name s/things/ /隧道/通知

Subscribe

AWS IoT 发布此消息以让 IoT 代理在远程设备上启动本地代理。有关更多信息,请参阅 IoT 代理代码段

影子主题

本节中的主题由命名和未命名的影子使用。每个影子使用的主题仅在主题前缀上有所不同。下表显示每种影子类型使用的主题前缀。

ShadowTopicPrefix 影子类型
$aw thingName s/things/ /shad 未命名的(经典)影子
$aw thingName s/things/ /shadow/name/ shadowName 命名的影子

要创建完整的主题,请选择要引用的影子类型,将其替换ShadowTopicPrefixthingName为相应的值(如果适用),然后将其附加到主题存根,如下表所示。shadowName请记住,主题区分大小写。

主题 允许的客户端操作 描述

ShadowTopicPrefix/删除

发布/订阅

设备或应用程序向此主题发布消息以删除影子。有关更多信息,请参阅 /delete

ShadowTopicPrefix/删除/接受

Subscribe

当一个影子被删除时,Device Shadow 服务将向此主题发送消息。有关更多信息,请参阅 /delete/accepted

ShadowTopicPrefix/删除/已拒绝

Subscribe

当删除影子的请求遭拒时,Device Shadow 服务将向此主题发送消息。有关更多信息,请参阅 /delete/rejected

ShadowTopicPrefix/get

发布/订阅

应用程序或事物向此主题发布空消息来获取影子。有关更多信息,请参阅 Device Shadow MQTT 话题

ShadowTopicPrefix/get/已接受

Subscribe

当获取影子的请求获批时,Device Shadow 服务将向此主题发送消息。有关更多信息,请参阅 /get/accepted

ShadowTopicPrefix/get/被拒绝

Subscribe

当获取影子的请求遭拒时,Device Shadow 服务将向此主题发送消息。有关更多信息,请参阅 /get/rejected

ShadowTopicPrefix/更新

发布/订阅

事物或应用程序向此主题发布消息以更新影子。有关更多信息,请参阅 /update

ShadowTopicPrefix/更新/已接受

Subscribe

当影子更新成功时,Device Shadow 服务将向此主题发送消息。有关更多信息,请参阅 /update/accepted

ShadowTopicPrefix/更新/已拒绝

Subscribe

当影子更新遭拒时,Device Shadow 服务将向此主题发送消息。有关更多信息,请参阅 /update/rejected

ShadowTopicPrefix/update/delta

Subscribe

当检测到影子的“reported”部分与“desired”部分之间存在差异时,Device Shadow 服务将向此主题发送消息。有关更多信息,请参阅 /update/delta

ShadowTopicPrefix/更新/文档

Subscribe

AWS IoT 每当成功执行影子更新时,都会向该主题发布状态文档。有关更多信息,请参阅 /update/documents

MQTT基于文件传输的主题

注意

此表中标为 R eceive 的客户端操作表示直接向请求它的客户端 AWS IoT 发布的主题,无论该客户是否订阅了该主题。即使客户端尚未订阅这些消息,也会收到这些消息。这些响应消息不会通过消息代理,也无法由其它客户端或规则订阅。

这些消息支持简明二进制对象表示 (CBOR) 格式和 JavaScript 对象表示法 (JSON) 的响应缓冲区,具体取决于主题。payload-format

payload-format 响应格式数据类型
cbor 简洁的二进制对象表示 (CBOR)
json JavaScript 物体标记 (JSON)
主题 允许的客户端操作 描述

$aws/things/ /streams/ /data/ ThingName StreamId payload-format

订阅,接收

AWS MQTT如果设备的 “GetStream” 请求被接受,则基于文件的传输会发布到此主题。负载包含流数据。有关更多信息,请参阅 在设备中使用 AWS IoT 基于 MQTT 的文件传输

$aws/things/ /streams/ /get/ ThingName StreamId payload-format

发布

设备向该主题发布消息以执行 “GetStream” 请求。有关更多信息,请参阅 在设备中使用 AWS IoT 基于 MQTT 的文件传输

$aws/things/ /streams/ /描述/ ThingName StreamId payload-format

订阅,接收

AWS MQTT如果设备的 “DescribeStream” 请求被接受,则基于文件的传输会发布到此主题。负载包含流描述。有关更多信息,请参阅 在设备中使用 AWS IoT 基于 MQTT 的文件传输

$aws/things/ /streams/ /describe/ ThingName StreamId payload-format

发布

设备向该主题发布消息以执行 “DescribeStream” 请求。有关更多信息,请参阅 在设备中使用 AWS IoT 基于 MQTT 的文件传输

$aws/things/ /streams/ /rejected/ ThingName StreamId payload-format

订阅,接收

AWS MQTT如果来自设备的 “” 或 “DescribeStreamGetStream” 请求被拒绝,则基于文件的传输会发布到此主题。有关更多信息,请参阅 在设备中使用 AWS IoT 基于 MQTT 的文件传输

保留话题 ARN

所有保留主题ARNs(Amazon 资源名称)均采用以下格式:

arn:aws:iot:aws-region:AWS-account-ID:topic/Topic

例如,arn:aws:iot:us-west-2:123EXAMPLE456:topic/$aws/things/thingName/jobs/get/accepted是ARN针对保留主题的$aws/things/thingName/jobs/get/accepted