預留主題 - AWS IoT Core

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

預留主題

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

資產模型主題

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

$aws/sitewise/asset-models/assetModelId/assets/assetId/屬性/propertyId

訂閱

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

AWS IoT Device Defender 主題

這些訊息支援精簡二進位物件表示法 (CBOR) 格式和 JavaScript 物件表示法 (JSON) 中的回應緩衝區,取決於 payload-format 僅支援MQTT發佈。 AWS IoT Device Defender topics。

payload-format 回應格式資料類型
cbor 精簡二進位物件表示法 (CBOR)
json JavaScript 物件記號 (JSON)

如需詳細資訊,請參閱從裝置傳送指標。

主題 允許操作 描述

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

發佈

AWS IoT Device Defender 客服人員會將指標發佈至此主題。如需詳細資訊,請參閱從裝置傳送指標。

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

訂閱

AWS IoT 在 AWS IoT Device Defender 客服人員將成功訊息發佈至 $aws/things/ 之後, 會發佈至此主題thingName/defender/metrics/payload-format。 如需詳細資訊,請參閱從裝置傳送指標。

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

訂閱

AWS IoT 在 AWS IoT Device Defender 客服人員向 $aws/things/ 發佈失敗訊息後, 會發佈至此主題thingName/defender/metrics/payload-format。 如需詳細資訊,請參閱從裝置傳送指標

AWS IoT Core 裝置位置主題

AWS IoT Core Device Location 可以從您的裝置解析測量資料,並提供 IoT 裝置的預估位置。裝置中的測量資料可以包含 GNSS、Wi-Fi、行動網路和 IP 地址。然後, AWS IoT Core Device Location 會選擇提供最佳準確度的測量類型,並解決裝置位置資訊。如需詳細資訊,請參閱 AWS IoT Core 裝置位置使用 Device Location MQTT主題解析 AWS IoT Core 裝置位置

主題 允許操作 描述

$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 個錯誤而無法成功解析裝置位置時,裝置位置會發佈至此主題。

事件主題

某些事件發生時,會發佈事件訊息。例如,在新增、更新或刪除事物時,由登錄檔產生的事件。資料表顯示各種 AWS IoT 事件及其預留主題。

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

$aws/events/certificates/registered/caCertificateId

訂閱

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

$aws/events/job/jobID/取消

訂閱

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

訂閱

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

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

訂閱

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

訂閱

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

訂閱

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

訂閱

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

訂閱

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

訂閱

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

訂閱

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

訂閱

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

訂閱

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

訂閱

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

$aws/events/presence/connected/clientId

訂閱

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

$aws/events/presence/disconnected/clientId

訂閱

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

$aws/events/subscriptions/subscribed/clientId

訂閱

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

$aws/events/subscriptions/unsubscribed/clientId

訂閱

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

$aws/events/thing/thingName/已建立

訂閱

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

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

訂閱

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

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

訂閱

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

$aws/events/thingGroup/thingGroupName/已建立

訂閱

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

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

訂閱

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

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

訂閱

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

$aws/events/thingType/thingTypeName/已建立

訂閱

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

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

訂閱

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

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

訂閱

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

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

訂閱

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

$aws/events/thingGroupMembership/thingGroup/thingGroupName/thing/thingName/已新增

訂閱

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

$aws/events/thingGroupMembership/thingGroup/thingGroupName/thing/thingName/已移除

訂閱

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

$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/已新增

訂閱

AWS IoT 當物件群組 childThingGroupName 已新增至物件群組 parentThingGroupName。 如需詳細資訊,請參閱 登錄檔事件

$aws/events/thingGroupHierarchy/thingGroup/parentThingGroupName/childThingGroup/childThingGroupName/已移除

訂閱

AWS IoT 當物件群組 childThingGroupName 從物件群組中移除 parentThingGroupName。 如需詳細資訊,請參閱 登錄檔事件

機群佈建主題

注意

本表中標記為接收的用戶端操作會指出直接 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/payload-format/接受

訂閱、接收

AWS IoT 成功地呼叫 $aws/certificates/create-from-csr/payload-format.

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

訂閱、接收

AWS IoT 會將不成功的呼叫發佈至此主題,呼叫 $aws/certificates/create-from-csr/payload-format.

$aws/provisioning-templates/templateName/佈建/payload-format

發佈

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

$aws/provisioning-templates/templateName/佈建/payload-format/接受

訂閱、接收

AWS IoT 成功呼叫 $aws/provisioning-templates/ 後, 會發佈至此主題templateName/佈建/payload-format.

$aws/provisioning-templates/templateName/佈建/payload-format/拒絕

訂閱、接收

AWS IoT 在呼叫 $aws/provisioning-templates/ 失敗之後, 會發佈至此主題templateName/佈建/payload-format.

任務主題

注意

此表中標記為接收的用戶端操作會指出直接 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/已完成

訂閱

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

$aws/events/job/jobId/取消

訂閱

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

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

訂閱

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

$aws/events/job/jobId/cancellation_in_progress

訂閱

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

$aws/events/job/jobId/deletion_in_progress

訂閱

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

$aws/events/jobExecution/jobId/成功

訂閱

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

$aws/events/jobExecution/jobId/失敗

訂閱

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

$aws/events/jobExecution/jobId/拒絕

訂閱

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

$aws/events/jobExecution/jobId/取消

訂閱

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

$aws/events/jobExecution/jobId/timed_out

訂閱

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

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

訂閱

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

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

訂閱

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

規則主題

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

$aws/rules/ruleName

發佈

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

安全通道主題

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

$aws/things/thing-name/通道/通知

訂閱

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

影子主題

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

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

若要建立完整主題,請選取 ShadowTopicPrefix 對於您要參考的影子類型,請取代 thingName 如果適用,shadowName,並使用其對應的值,然後使用主題短條附加該值,如下表所示。請記住,主題會區分大小寫。

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

ShadowTopicPrefix/delete

發佈/訂閱

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

ShadowTopicPrefix/delete/accepted

訂閱

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

ShadowTopicPrefix/delete/rejected

訂閱

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

ShadowTopicPrefix/get

發佈/訂閱

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

ShadowTopicPrefix/get/accepted

訂閱

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

ShadowTopicPrefix/get/rejected

訂閱

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

ShadowTopicPrefix/update

發佈/訂閱

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

ShadowTopicPrefix/update/accepted

訂閱

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

ShadowTopicPrefix/update/rejected

訂閱

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

ShadowTopicPrefix/update/delta

訂閱

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

ShadowTopicPrefix/update/documents

訂閱

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

MQTT以 為基礎的檔案交付主題

注意

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

這些訊息支援精簡二進位物件表示法 (CBOR) 格式和 JavaScript 物件表示法 (JSON) 中的回應緩衝區,取決於 payload-format 主題的 。

payload-format 回應格式資料類型
cbor 精簡二進位物件表示法 (CBOR)
json JavaScript 物件記號 (JSON)
主題 允許的用戶端操作 描述

$aws/things/ThingName/streams/StreamId/資料/payload-format

訂閱、接收

AWS MQTT如果接受來自裝置的「GetStream」請求,則 型檔案交付會發佈到此主題。承載包含串流資料。如需詳細資訊,請參閱在裝置中使用 AWS IoT MQTT型檔案交付

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

發佈

裝置會發佈至此主題,以執行「GetStream」請求。如需詳細資訊,請參閱在裝置中使用 AWS IoT MQTT型檔案交付

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

訂閱、接收

AWS MQTT如果接受來自裝置的「DescribeStream」請求,則 型檔案交付會發佈到此主題。承載包含串流描述。如需詳細資訊,請參閱在裝置中使用 AWS IoT MQTT型檔案交付

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

發佈

裝置會發佈至此主題,以執行「DescribeStream」請求。如需詳細資訊,請參閱在裝置中使用 AWS IoT MQTT型檔案交付

$aws/things/ThingName/streams/StreamId/拒絕/payload-format

訂閱、接收

AWS MQTT如果來自裝置的「DescribeStream」或「GetStream」請求遭到拒絕,則 型檔案交付會發佈到此主題。如需詳細資訊,請參閱在裝置中使用 AWS IoT MQTT型檔案交付

預留主題 ARN

所有預留主題 ARNs(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是預留主題 ARN 的 $aws/things/thingName/jobs/get/accepted