預留主題 - AWS IoT Core

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

預留主題

以美元符號 ($) 開頭的主題會保留供使用 AWS IoT。在允許的情況下,您可以訂閱並發佈至這些預留主題;然而您無法建立以貨幣符號開頭的新主題。不支援的發佈或訂閱預留主題作業可能會導致連線終止。

資產模型主題

主題 允許的用戶端操作 描述

$ aws/網站維護/資產模型//資產/assetId 編號/屬性/屬性 ID assetModelId

訂閱

AWS IoT SiteWise 將資產性質通知發佈至此主題。如需詳細資訊,請參閱《AWS IoT SiteWise 使用指南》中的「與其他 AWS 服務互動」。

AWS IoT Device Defender 主題

這些訊息支援簡潔二進位物件表示法 (CBOR) 格式和 JavaScript 物件標記法 (JSON) 的回應緩衝區,視主題的有效負載格式而定。 AWS IoT Device Defender 主題僅支援 MQTT 發佈。

承載格式 回應格式資料類型
cbor Concise Binary Object Representation (CBOR)
json JavaScript 对象标记法

如需詳細資訊,請參閱從裝置傳送量度

主題 允許操作 描述

$aws/things/thingName/defender/metrics/payload-format

發佈

AWS IoT Device Defender 代理程式會將量度發佈至此主題。如需詳細資訊,請參閱從裝置傳送量度

$aws/things/thingName/defender/metrics/payload-format/accepted

訂閱

AWS IoT 在 AWS IoT Device Defender 代理程式將成功訊息發佈為 $aws/事物/ThingthingName /防護者/量度/ 有效負載格式後,發佈至此主題。如需詳細資訊,請參閱從裝置傳送量度

$aws/things/thingName/defender/metrics/payload-format/rejected

訂閱

AWS IoT 在 AWS IoT Device Defender 代理程式將不成功的訊息發佈為 $aws/事物/ThingthingName /防護者/量度/ 有效負載格式後,發佈至此主題。如需詳細資訊,請參閱從裝置傳送量度

AWS IoT Core 裝置位置主題

AWS IoT Core 裝置位置可以解析裝置中的測量資料,並提供 IoT 裝置的估計位置。來自設備的測量數據可以包括 GNSS,Wi-Fi,蜂窩和 IP 地址。 AWS IoT Core 然後,「裝置位置」選擇可提供最佳精度的量測類型,並解析裝置位置資訊。如需詳細資訊,請參閱 AWS IoT Core 裝置位置使用 AWS IoT Core 裝置位置 MQTT 主題解析裝置位置

主題 允許操作 描述

$aws/device_location/customer_device_id/get_position_estimate

發佈

裝置會發佈至此主題,以取得由裝置位 AWS IoT Core 置解析的掃描原始量測資料。

$aws/device_location/customer_device_id/get_position_estimate/accepted

訂閱

AWS IoT Core 裝置位置成功解析裝置位置後,會發佈至此主題。

$aws/device_location/customer_device_id/get_position_estimate/rejected

訂閱

AWS IoT Core 由於 4xx 錯誤而無法成功解析裝置位置時,裝置位置會發佈至此主題。

事件主題

注意

如需 LoRa WAN 事件的保留 MQTT 主題的詳細資訊,請參閱連線狀態事件。

主題 允許的用戶端操作 描述

$aws/events/ 證書/已登記/ caCertificateId

訂閱

AWS IoT 當 AWS IoT 自動註冊憑證,以及當用戶端顯示具有PENDING_ACTIVATION狀態的憑證時,會發佈此訊息。如需詳細資訊,請參閱 設定用戶端的首次連線進行自動註冊

$aws/events/job/jobID/canceled

訂閱

AWS IoT 取消工作時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/job/jobID/cancellation_in_progress

訂閱

AWS IoT 當工作取消進行時,會發佈此訊息。如需詳細資訊,請參閱 任務事件

$aws/events/job/jobID/completed

訂閱

AWS IoT 當工作完成時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/job/jobID/deleted

訂閱

AWS IoT 刪除工作時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/job/jobID/deletion_in_progress

訂閱

AWS IoT 當工作刪除正在進行時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/jobExecution/jobID/canceled

訂閱

AWS IoT 取消工作執行時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/jobExecution/jobID/deleted

訂閱

AWS IoT 刪除工作執行時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/jobExecution/jobID/failed

訂閱

AWS IoT 當工作執行失敗時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/jobExecution/jobID/rejected

訂閱

AWS IoT 拒絕工作執行時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/jobExecution/jobID/removed

訂閱

AWS IoT 移除工作執行時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/jobExecution/jobID/succeeded

訂閱

AWS IoT 當工作執行成功時,會發佈此訊息。如需詳細資訊,請參閱 任務事件
$aws/events/jobExecution/jobID/timed_out

訂閱

AWS IoT 當工作執行逾時時,會發佈此訊息。如需詳細資訊,請參閱 任務事件

$aws/events/presence/connected/clientId

訂閱

AWS IoT 當具有指定用戶端 ID 的 MQTT 用戶端連線至時,會發佈至此主題。 AWS IoT如需詳細資訊,請參閱 連線/中斷連線事件

$aws/events/presence/disconnected/clientId

訂閱

AWS IoT 當具有指定用戶端 ID 的 MQTT 用戶端中斷連線時,會發佈至此主題。 AWS IoT如需詳細資訊,請參閱 連線/中斷連線事件

$aws/events/subscriptions/subscribed/clientId

訂閱

AWS IoT 當具有指定用戶端識別碼的 MQTT 用戶端訂閱 MQTT 主題時,會發佈至本主題。如需詳細資訊,請參閱 訂閱/取消訂閱事件

$aws/events/subscriptions/unsubscribed/clientId

訂閱

AWS IoT 當具有指定用戶端 ID 的 MQTT 用戶端取消訂閱 MQTT 主題時,會發佈至本主題。如需詳細資訊,請參閱 訂閱/取消訂閱事件

$aws/events/thing/thingName/created

訂閱

AWS IoT 建立「thingName」物件時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/thing/thingName/updated

訂閱

AWS IoT 當更新「thingName」物件時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/thing/thingName/deleted

訂閱

AWS IoT 刪除「thingName」物件時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ thingGroupName物件群組//已建立的

訂閱

AWS IoT 建立物群組thingGroupName時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ thingGroupName物件群組//已更新

訂閱

AWS IoT 更新物件群組thingGroupName時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ thingGroupName物件群組//已刪除的

訂閱

AWS IoT 刪除物件群組thingGroupName時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ 類型/ /已建立thingTypeName

訂閱

AWS IoT 建立thingTypeName物件類型時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ 類型/ /已更thingTypeName

訂閱

AWS IoT 當thingTypeName物件類型更新時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ 類型/ /已刪除thingTypeName

訂閱

AWS IoT 刪除thingTypeName物件類型時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ thingName/thingTypeAssociationthingTypeName

訂閱

AWS IoT 當物件 ThingName 與物類型相關聯或與物類型取消關聯時,會發佈至此主題。thingTypeName如需詳細資訊,請參閱 登錄檔事件

$aws/events/ 事件/物組/ 事物/事物 thingName/thingGroupMembership已添加 thingGroupName

訂閱

AWS IoT 將物件 ThingName 新增至物群組thingGroupName時,會發佈至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ 事件/物組/ 事物/事物 thingName/thingGroupMembership已刪除 thingGroupName

訂閱

AWS IoT 從物件群thingGroupName組中移除物件 ThingName 時,會發行至此主題。如需詳細資訊,請參閱 登錄檔事件

$aws/events/ 事件組/姓名//姓名thingGroupHierarchy/添parentThingGroup加 childThingGroup childThingGroup

訂閱

AWS IoT 將物件群組名稱新增至物群組childThingGroup名稱時,會發佈至此主題。parentThingGroup如需詳細資訊,請參閱 登錄檔事件

$aws/events/ 事件組/名稱//姓名thingGroupHierarchy/parentThingGroup已刪除 childThingGroup childThingGroup

訂閱

AWS IoT 從物群組名稱移除物件群組childThingGroup名稱時,會發佈至此主題。parentThingGroup如需詳細資訊,請參閱 登錄檔事件

機群佈建主題

注意

此表格中標示為「接」的用戶端作業會指出直接 AWS IoT 發佈至要求該主題的用戶端的主題,無論用戶端是否已訂閱主題。即使用戶端尚未訂閱回應訊息,也應該預期會收到這些訊息。這些回應訊息不會透過訊息代理程式傳遞,而且其他用戶端或規則無法訂閱這些訊息。

這些訊息支援簡潔二進位物件表示法 (CBOR) 格式和 JavaScript 物件標記法 (JSON) 的回應緩衝區,視主題的有效負載格式而定。

承載格式 回應格式資料類型
cbor Concise Binary Object Representation (CBOR)
json JavaScript 对象标记法

如需詳細資訊,請參閱 裝置佈建 MQTT API

主題 允許的用戶端操作 描述

$aws/certificates/create/payload-format

發佈

發佈到這個主題,以從憑證簽署要求 (CSR) 建立憑證。

$aws/certificates/create/payload-format/accepted

訂閱、接收

AWS IoT 成功調用 $ aws/證書/創建/ 有效負載格式後發布到此主題。

$aws/certificates/create/payload-format/rejected

訂閱、接收

AWS IoT 在對 $aws/ 證書/創建/有效負載格式的調用失敗後發布到此主題。

$aws/證書//create-from-csr有效負載格式

發佈

發佈至本主題,以從 CSR 建立憑證。

$aws/證書//有效負載格式/create-from-csr接受

訂閱、接收

AWS IoT 發布到此主題成功調用 $ aws/證書//create-from-csr有效負載格式。

$aws/證書//有效負載格式/拒絕 create-from-csr

訂閱、接收

AWS IoT 向此主題發布對 $ aws/證書//create-from-csr有效負載格式的不成功調用。

$aws/provisioning-templates/templateName/provision/payload-format

發佈

發佈至此主題以註冊實物。

$aws/provisioning-templates/templateName/provision/payload-format/accepted

訂閱、接收

AWS IoT 在成功調用 $aws/佈建模板/ 模板 templateName 稱/佈建/有效載入格式後發佈到此主題。

$aws/provisioning-templates/templateName/provision/payload-format/rejected

訂閱、接收

AWS IoT 在對 $ aws/提供模板/ 模板名稱/提供/有效負載格式的調用失敗後發布到此主題。

任務主題

注意

此表格中標示為「接」的用戶端作業會指出直接 AWS IoT 發佈至要求該主題的用戶端的主題,無論用戶端是否已訂閱主題。即使用戶端尚未訂閱回應訊息,也應該預期會收到這些訊息。

這些回應訊息不會透過訊息代理程式傳遞,而且其他用戶端或規則無法訂閱這些訊息。若要訂閱任務活動相關訊息,請使用 notifynotify-next 主題。

為機群監控解決方案訂閱任務和 jobExecution 事件主題時,您必須先啟用任務和任務執行事件來接收雲端上的任何事件。

如需詳細資訊,請參閱 任務裝置 MQTT API 操作

主題 允許的用戶端操作 描述

$aws/things/thingName/jobs/get

發佈

裝置發佈訊息到這個主題來提出 GetPendingJobExecutions 請求。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/get/accepted

訂閱、接收

裝置訂閱此主題,以接收來自 GetPendingJobExecutions 請求的成功回應。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/get/rejected

訂閱、接收

GetPendingJobExecutions 請求被拒時,裝置會訂閱此主題以接收回應。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/start-next

發佈

裝置發佈訊息到這個主題來提出 StartNextPendingJobExecution 請求。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/start-next/accepted

訂閱、接收

裝置訂閱此主題,以接收送往 StartNextPendingJobExecution 請求的成功回應。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/start-next/rejected

訂閱、接收

StartNextPendingJobExecution 請求被拒時,裝置會訂閱此主題以接收回應。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

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

發佈

裝置發佈訊息到這個主題來提出 DescribeJobExecution 請求。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/jobId/get/accepted

訂閱、接收

裝置訂閱此主題,以接收送往 DescribeJobExecution 請求的成功回應。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/jobId/get/rejected

訂閱、接收

DescribeJobExecution 請求被拒時,裝置會訂閱此主題以接收回應。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/jobId/update

發佈

裝置發佈訊息到這個主題來提出 UpdateJobExecution 請求。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/jobId/update/accepted

訂閱、接收

裝置訂閱此主題,以接收送往 UpdateJobExecution 請求的成功回應。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

注意

只有發佈到 $aws/things/thingName/jobs/jobId/update 的設備才會收到此主題的訊息。

$aws/things/thingName/jobs/jobId/update/rejected

訂閱、接收

UpdateJobExecution 請求被拒時,裝置會訂閱此主題以接收回應。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

注意

只有發佈到 $aws/things/thingName/jobs/jobId/update 的設備才會收到此主題的訊息。

$aws/things/thingName/jobs/notify

訂閱、接收

裝置訂閱此主題,以在物件的待處理執行清單新增或移除任務執行時接收通知。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/things/thingName/jobs/notify-next

訂閱、接收

裝置訂閱此主題,以在物件的下一個待處理任務執行變更時接收通知。如需詳細資訊,請參閱 任務裝置 MQTT API 操作

$aws/events/job/jobId/completed

訂閱

任務完成時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/job/jobId/canceled

訂閱

任務取消時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/job/jobId/deleted

訂閱

任務刪除時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/job/jobId/cancellation_in_progress

訂閱

開始取消任務時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/job/jobId/deletion_in_progress

訂閱

開始刪除任務時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/jobExecution/jobId/succeeded

訂閱

任務執行成功時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/jobExecution/jobId/failed

訂閱

任務執行失敗時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/jobExecution/jobId/rejected

訂閱

任務執行遭拒時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/jobExecution/jobId/canceled

訂閱

任務執行取消時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/jobExecution/jobId/timed_out

訂閱

任務執行逾時時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/jobExecution/jobId/removed

訂閱

任務執行移除時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

$aws/events/jobExecution/jobId/deleted

訂閱

任務執行刪除時,任務服務會發佈這個主題的事件。如需詳細資訊,請參閱 任務事件

規則主題

主題 允許的用戶端操作 描述

$aws/rules/ruleName

發佈

裝置或應用程式會發佈至此主題,以直接觸發規則。如需詳細資訊,請參閱 使用基本擷取減少簡訊費用

安全通道主題

主題 允許的用戶端操作 描述

$aws/things/thing-name/tunnels/notify

訂閱

AWS IoT 針對 IoT 代理程式發佈此訊息,以便在遠端裝置上啟動本機 Proxy。如需詳細資訊,請參閱 IoT Agent Snippet

影子主題

已命名的影子和未命名的影子會使用本節中的主題。各影子所使用的主題只有在主題字首中有所不同。此表格會顯示每種影子類型所使用的主題字首。

ShadowTopicPrefix 影子類型
$aws/things/thingName/shadow 未命名 (經典) 影子
$aws/things/thingName/shadow/name/shadowName 已命名影子

欲建立完整主題,請ShadowTopicPrefix針對您要參照的陰影類型選取,將 thingName 取代為適用的 shadow Name,並使用其對應值將其附加至主題虛設常式,如下表所示。請記住,主題會區分大小寫。

主題 允許的用戶端操作 描述

ShadowTopicPrefix/刪除

發佈/訂閱

裝置或應用程式會發佈至此主題,以刪除影子。如需詳細資訊,請參閱 /delete

ShadowTopicPrefix/刪除/接受

訂閱

當影子刪除時,Device Shadow 服務會傳送訊息至此主題。如需詳細資訊,請參閱 /delete/accepted

ShadowTopicPrefix/刪除/拒絕

訂閱

拒絕刪除影子的要求時,Device Shadow 服務會傳送訊息至此主題。如需詳細資訊,請參閱 /delete/rejected

ShadowTopicPrefix/得到

發佈/訂閱

應用程式或物件會發佈空白訊息至此主題,以取得影子。如需詳細資訊,請參閱 Device Shadow MQTT 主題

ShadowTopicPrefix/獲得/接受

訂閱

當要求影子成功時,Device Shadow 服務會傳送訊息至此主題。如需詳細資訊,請參閱 /get/accepted

ShadowTopicPrefix/取得/拒絕

訂閱

當要求影子被拒絕時,Device Shadow 服務會傳送訊息至此主題。如需詳細資訊,請參閱 /get/rejected

ShadowTopicPrefix/更新

發佈/訂閱

物件或應用程式會發佈至此主題,以更新影子。如需詳細資訊,請參閱 /update

ShadowTopicPrefix/更新/已接受

訂閱

當更新影子成功時,Device Shadow 服務會傳送訊息至此主題。如需詳細資訊,請參閱 /update/accepted

ShadowTopicPrefix/更新/拒絕

訂閱

當更新影子被拒絕時,Device Shadow 服務會傳送訊息至此主題。如需詳細資訊,請參閱 /update/rejected

ShadowTopicPrefix/更新/三角

訂閱

當偵測到回報的區段與所需的區段之間發生差異時,Device Shadow 服務會傳送訊息至此主題。如需詳細資訊,請參閱 /update/delta

ShadowTopicPrefix/更新/文件

訂閱

AWS IoT 每當成功執行陰影更新時,都會將狀態文件發佈至此主題。如需詳細資訊,請參閱 /update/documents

MQTT 型檔案交付主題

注意

此表格中標示為「接」的用戶端作業會指出直接 AWS IoT 發佈至要求該主題的用戶端的主題,無論用戶端是否已訂閱主題。即使用戶端尚未訂閱回應訊息,也應該預期會收到這些訊息。這些回應訊息不會透過訊息代理程式傳遞,而且其他用戶端或規則無法訂閱這些訊息。

這些訊息支援簡潔二進位物件表示法 (CBOR) 格式和 JavaScript 物件標記法 (JSON) 的回應緩衝區,視主題的有效負載格式而定。

承載格式 回應格式資料類型
cbor Concise Binary Object Representation (CBOR)
json JavaScript 对象标记法
主題 允許的用戶端操作 描述

$aws/事物//流/ 數據/ThingName有效負載格式 StreamId

訂閱、接收

AWS 如果接受來自裝置的 "GetStream" 要求,以 MQTT 為基礎的檔案傳遞會發佈至本主題。承載包含串流資料。如需詳細資訊,請參閱 在裝置中使用以 AWS IoT MQTT 為基礎的檔案傳遞

$ aws/事物//流/ /獲得/有效負載格ThingNameStreamId

發佈

裝置會發佈至此主題以執行 "GetStream" 要求。如需詳細資訊,請參閱 在裝置中使用以 AWS IoT MQTT 為基礎的檔案傳遞

$aws/事/ /流/ /描述/有效載荷ThingName格式 StreamId

訂閱、接收

AWS 如果接受來自裝置的 "DescribeStream" 要求,以 MQTT 為基礎的檔案傳遞會發佈至本主題。承載包含串流描述。如需詳細資訊,請參閱 在裝置中使用以 AWS IoT MQTT 為基礎的檔案傳遞

$aws/事/ /流/ /說明/ 有效載荷ThingName格式 StreamId

發佈

裝置會發佈至此主題以執行 "DescribeStream" 要求。如需詳細資訊,請參閱 在裝置中使用以 AWS IoT MQTT 為基礎的檔案傳遞

$aws/事/ /流/ /拒絕/有效負載格式 ThingNameStreamId

訂閱、接收

AWS 如果來自裝置的 "" 或 "DescribeStreamGetStream" 要求遭到拒絕,MQTT 型檔案傳遞會發佈至此主題。如需詳細資訊,請參閱 在裝置中使用以 AWS IoT MQTT 為基礎的檔案傳遞

預留的主題 ARN

所有預留的主題 ARN (Amazon Resource Names) 都具有以下形式:

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

例如,arn:aws:iot:us-west-2:123EXAMPLE456:topic/$aws/things/thingName/jobs/get/accepted 是預留主題 $aws/things/thingName/jobs/get/accepted 的 ARN。