IoT Hub データ プレーン MQTT 5 API リファレンス (非推奨)

このドキュメントでは、IoT Hub データ プレーン API のバージョン 2.0 (api-version: 2020-10-01-preview) で使用できる操作を定義します。

オペレーションズ

ツインを取得する

ツインの取得の状態

依頼

トピック名:$iothub/twin/get

プロパティ: なし

ペイロード: 空

成功時の応答

プロパティ: なし

ペイロード:ツイン

代替応答

擬似コードのサンプル

-> PUBLISH
    QoS: 0
    Topic: $iothub/twin/get
<- PUBLISH
    QoS: 0
    Topic: $iothub/responses

パッチ ツインの報告

パッチ ツインの報告の状態

依頼

トピック名:$iothub/twin/patch/reported

[プロパティ] :

ペイロード:TwinState

成功時の応答

[プロパティ] :

ペイロード: 空

代替応答

擬似コードのサンプル

-> PUBLISH
    QoS: 0
    Topic: $iothub/twin/patch/reported
    [if-version: <u64>]
<- PUBLISH
    QoS: 0
    Topic: $iothub/responses

コマンドを受信する

コマンドを受信して処理する

メッセージ

トピック名:$iothub/commands

[プロパティ] :

ペイロード: 任意のバイト シーケンス

成功の受信確認

クライアントによる処理のためにコマンドが受け入れられたことを示します

プロパティ: なし

ペイロード: 空

代替受信確認

擬似コードのサンプル

-> SUBSCRIBE
    - Topic: $iothub/commands
      QoS: 1
<- PUBLISH
    QoS: 1
    Topic: $iothub/commands
    sequence-no: <u64>enqueued-time: <time>delivery-count: <u32>[creation-time: <time>][message-id: <string>][user-id: <string>][correlation-id: <string>][Content Type: <string>][content-encoding: <string>]
    Payload: ...

-> PUBACK

ダイレクト メソッドを受信する

ダイレクト メソッドの呼び出しを受信して処理する

依頼

トピック名:$iothub/methods/{name}

プロパティ: なし

ペイロード: 任意のバイト シーケンス

成功時の応答

[プロパティ] :

ペイロード: 任意のバイト シーケンス

代替応答

擬似コードのサンプル

-> SUBSCRIBE
    - Topic: methods/{name}
      QoS: 0
<- SUBACK
<- PUBLISH
    QoS: 0
    Topic: $iothub/methods/{name}
-> PUBLISH
    QoS: 0
    Topic: $iothub/responses

ツインの望ましい状態の変更を受信する

ツインの望ましい状態の更新プログラムを受信する

メッセージ

トピック名:$iothub/twin/patch/desired

[プロパティ] :

ペイロード:TwinState

擬似コードのサンプル

-> SUBSCRIBE
    - Topic: $iothub/twin/patch/desired
      QoS: 0
<- PUBLISH
    QoS: 0
    Topic: $iothub/twin/patch/desired
    version: <u64>
    Payload: ...

テレメトリを送信する

テレメトリ チャネル (既定では Event Hubs、ルーティング構成を使用する場合はその他のエンドポイント) にメッセージを投稿します。

メッセージ

トピック名:$iothub/telemetry

[プロパティ] :

ペイロード: 任意のバイト シーケンス

成功の受信確認

メッセージがテレメトリ チャネルに正常に投稿されました

プロパティ: なし

ペイロード: 空

代替受信確認

擬似コードのサンプル

-> PUBLISH
    QoS: 1
    Topic: $iothub/telemetry
    [Content Type: <string>]
    [content-encoding: <string>]
    [message-id: <string>]
    [user-id: <string>]
    [correlation-id: <string>]
    [creation-time: <time>]

<- PUBACK

応答

無効な要求

操作メッセージの形式が正しくないため、処理できません。

理由コード:131

状態:0100

[プロパティ] :

ペイロード: 空

葛藤

操作は、実行中の別の操作と競合しています。

理由コード:131

状態:0103

[プロパティ] :

ペイロード: 空

禁じられた

操作は許可されていません。

理由コード:131

状態:0102

[プロパティ] :

ペイロード: 空

権限なし

クライアントにはこの操作を実行する権限がありません。

理由コード:135

状態:0101

[プロパティ] :

ペイロード: 空

見つかりません

要求されたリソースが存在しません

理由コード:131

状態:0504

[プロパティ] :

ペイロード: 空

変更されていません

指定された前提条件に基づくリソース変更が行われませんでした。

理由コード:0

状態:0001

プロパティ: なし

ペイロード: 空

Precondition Failed

前提条件が満たされなかったため、要求が取り消されました

理由コード:131

状態:0104

プロパティ: なし

ペイロード: 空

クォータを超過した

現在の SKU ごとの 1 日あたりのクォータを超えています

理由コード:151

状態:0502

プロパティ: なし

ペイロード: 空

リソースを使い果たしました

リソースには操作を完了するための容量がありません

理由コード:131

状態:0503

[プロパティ] :

ペイロード: 空

サーバー ビジー

サーバーがビジー状態です

理由コード:131

状態:0603

[プロパティ] :

ペイロード: 空

サーバー エラー

内部サーバー エラー

理由コード:131

状態:0601

[プロパティ] :

ペイロード: 空

ターゲットが失敗しました

ターゲットは応答しましたが、その応答が無効であるか、形式が正しくありませんでした

理由コード:131

状態:06A2

[プロパティ] :

ペイロード: 空

ターゲットのタイムアウト

ターゲットで要求が完了するまで待機している間にタイムアウトになりました

理由コード:131

状態:06A1

[プロパティ] :

ペイロード: 空

ターゲットを使用できません

要求を完了するためにターゲットに到達できません

理由コード:131

状態:06A0

プロパティ: なし

ペイロード: 空

Throttled

SKU あたりの要求レートが高すぎます

理由コード:151

状態:0501

プロパティ: なし

ペイロード: 空

タイムアウト

操作が完了する前にタイムアウトになりました

理由コード:131

状態:0602

[プロパティ] :

ペイロード: 空