IoT Platform:データ形式

トピック

説明

参考資料

カスタム

カスタム形式でデータを転送するために使用されるトピック。 このトピックの形式は、カスタムトピックの形式と同じです。 形式: /${productKey}/${deviceName}/user/${TopicShortName}

${TopicShortName} は、カスタムトピックのサフィックスであるカスタムトピックカテゴリを指定します。

値には、プラス記号 (+) や数値記号 (#) などのワイルドカード文字を含めることができます。

• すべての機器 (+ ): 指定された製品のすべてのデバイスを示します。

• /user/#: 指定されたデバイスのすべてのトピックを示します。

カスタムトピックを使用した通信

デバイスステータス変更通知

デバイスのステータスがオンラインとオフラインの間で変化したときに通知を転送するために使用されるトピック。 形式: /as/mqtt/status/${productKey}/${deviceName}

デバイスステータスの送信

TSLデータレポート

以下のトピックを提供します。

• /${productKey}/${deviceName}/thing/event/property/post: このトピックはデバイスプロパティを転送するために使用されます。

• /${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post: このトピックは、デバイスイベントを転送するために使用されます。

• /${productKey}/${deviceName}/thing/property/batch/post: このトピックは、デバイスプロパティをバッチで転送するために使用されます。

• /${productKey}/${deviceName}/thing/event/batch/post: このトピックは、デバイスイベントをバッチで転送するために使用されます。

• /${productKey}/${deviceName}/thing/downlink/reply/message: このトピックは、デバイスがIoT Platformコマンドへの応答として返すメッセージを転送するために使用されます。

• デバイスプロパティの送信

• デバイスイベントの送信

• 一度に複数のデバイスプロパティを送信

• 一度に複数のデバイスイベントを送信

• ダウンストリームリクエストへのレスポンスの送信

デバイスデータの送信には、次のトピックを使用します。

• /sys/${productKey}/${deviceName}/thing/event/property/post: このトピックはデバイスプロパティの送信に使用されます。

• /sys/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/postおよび /sys/${productKey}/${deviceName}/thing/event/${tsl.functionBlockId }:{ tsl.event.identifier}/post: これらのトピックはデバイスイベントの送信に使用されます。

• /sys/${productKey}/${deviceName}/thing/event/property/batch/post: このトピックでは、デバイスプロパティとイベントをバッチで送信します。

• デバイスプロパティの送信

• デバイスイベントの送信

• 一度に複数のデバイスのプロパティとイベントを送信

ライフサイクル全体のデバイス変更

デバイスが作成、削除、無効、または有効になったときにメッセージを転送するために使用されるトピック。 形式: /${productKey}/${deviceName}/thing/lifecycle

ライフサイクル変更の送信

ゲートウェイで検出されたサブデバイスデータレポート

ゲートウェイがサブデバイスを検出したときに、新しいサブデバイスに関する情報を送信および転送するために使用されるトピック。 このトピックはゲートウェイに固有です。 形式: /${productKey}/${deviceName}/thing/list/found

検出されたサブデバイスに関する情報の送信

デバイスのトポロジ関係の変更

サブデバイスとゲートウェイ間のトポロジ関係が作成または削除されたときに通知を転送するために使用されるトピック。 このトピックはゲートウェイに固有です。 形式: /${productKey}/${deviceName}/thing/topo/lifecycle

デバイスのトポロジ関係の変更

/sys/${productKey}/${deviceName}/thing/topo/change: このトピックは、デバイスデータの送信に使用されます。

ゲートウェイにトポロジ関係の変更を通知

デバイスタグの変更

デバイスタグが変更されたときにメッセージを転送するために使用されるトピック。 形式: /${productKey}/${deviceName}/thing/deviceinfo/update

デバイスタグ変更の送信

/sys/${productKey}/${deviceName}/thing/deviceinfo/update: このトピックは、デバイスデータの送信に使用されます。

タグの送信

TSL履歴データレポート

以下のトピックを提供します。

• /${productKey}/${deviceName}/thing/event/property/history/post: このトピックは、履歴プロパティを転送するために使用されます。

• /${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/history/post: このトピックは、履歴イベントを転送するために使用されます。

• 送信履歴プロパティ

• 送信履歴イベント

/sys/${productKey}/${deviceName}/thing/event/property/history/post: このトピックは、過去のTSLデータの送信に使用されます。

デバイスのプロパティ、イベント、およびサービス

デバイスステータス通知

以下のトピックを提供します。

• /${productKey}/${deviceName}/ota/upgrade: このトピックは、無線 (OTA) 更新結果を転送するために使用されます。

• /${productKey}/${deviceName}/ota/progress/post: このトピックは、更新の進行状況を転送するために使用されます。

• OTAアップデートのステータスデータを送信

• OTAアップデートの進捗データを送信

上記のトピックは、/ota/device/progress/${productKey}/${deviceName} のトピックに対応しています。 このトピックは、更新の進行状況を送信するために使用されます。

更新の進行状況をIoT Platformに送信

モジュールのバージョン番号の送信

デバイスのOTAモジュールのバージョン番号が変更されたときにメッセージを転送するために使用されるトピック。 形式: /${productKey}/${deviceName}/ota/version/post

OTAモジュールのバージョンを送信する

上記のトピックは、/ota/device/inform/${productKey}/${deviceName} のトピックに対応しています。 このトピックは、OTAモジュールのバージョン番号を送信するために使用されます。

OTAモジュールのバージョンをIoT Platformに送信

バッチステータス通知

OTA更新バッチのステータスが変更されたときにIoT Platformがメッセージを送信するトピック。 形式: /${productKey}/${packageId}/${jobId}/ota/job/status

OTA更新バッチのステータスデータの送信

Jobイベント

/sys/uid/${uid}/distribution/${jobId}/lifecycle: デバイスジョブのステータスが変更されたときに通知を転送するために使用されるトピック。

インスタンスのデータ移行タスクのステータスデータの送信

パラメーター

データ型

説明

status

String

デバイスの名前 有効な値：

• オフライン

iotId

String

IoT Platformのデバイスの一意の識別子。

offlineReasonCode

Integer

デバイスがオフラインになったときに返されるエラーコード。 詳細については、「デバイスの動作に関連するエラーコード」をご参照ください。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

lastTime

String

これらのパラメータはもはや有効ではありません。

utcLastTime

String

時間

String

デバイスがオンラインまたはオフラインになった時刻。

返されたメッセージは時間によってソートされません。 手動でメッセージをソートする必要があります。

utcTime

String

デバイスがオンラインまたはオフラインになった時刻。 時刻はUTC形式です。

clientIp

String

デバイスのパブリックIPアドレス。

パラメーター

データ型

説明

iotId

String

IoT Platformのデバイスの一意の識別子。

requestId

String

メッセージのID。 有効な値: 0 ~ 4294967295 各メッセージIDは、デバイスに対して一意である必要があります。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

gmtCreate

Long

メッセージが生成された時刻。

deviceType

String

デバイスの製品カテゴリ。

IoT Platformでプロダクトを作成するときに、プロダクトカテゴリを指定できます。 詳細については、「プロダクトの作成」または「CreateProduct」をご参照ください。

アイテム

オブジェクト

デバイスによって送信されたデータ。

パワー

String

プロパティの識別子。 プロパティの詳細については、製品のTSLモデルを参照してください。

{
    "items":{
        "test:Power":{
            "value":"on",
            "time":1510799670074
        },
        "test: ポジション":{
            "time":1510292697470,
            "value":{
                "latitude":39.9,
                "longitude":116.38
            }
        }
    }
}

位置

attribute_8

checkFailedData

オブジェクト

検証に失敗したデータ。

値

TSL定義の対象

プロパティの値

時間

Long

プロパティが提出された時刻。 デバイスがタイムスタンプを送信しない場合、IoT Platformがメッセージを受信したときを示すタイムスタンプが使用されます。

コード

Integer

データの検証に失敗した場合に返されるエラーコード。 詳細については、「デバイスのエラーコード」をご参照ください。

メッセージ

String

データの検証に失敗した場合に返されるエラーメッセージ。 エラーメッセージには、失敗の原因と無効なパラメーターに関する情報が含まれています。

パラメーター

データ型

説明

識別子

String

イベントの識別子。

"test:identifier":"BrokenInfo" 、

name

String

イベント名。

タイプ

String

イベントのタイプ。 サポートされているイベントの種類については、製品のTSLモデルを参照してください。

iotId

String

IoT Platformのデバイスの一意の識別子。

requestId

String

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

gmtCreate

Long

メッセージが生成された時刻。

値

オブジェクト

イベントの出力パラメーター。 例: パワーとポジション。

{
    "パワー":"オン" 、
    "Position":{
        "latitude":39.9,
        "longitude":116.38
    }
}

checkFailedData

オブジェクト

検証に失敗したデータ。

出力パラメーターの検証に失敗した場合、checkFailedDataパラメーターには次のパラメーターが含まれます。

{
    "value":{
        "パワー":"オン" 、
        "Position":{
            "latitude":39.9,
            "longitude":116.38
        }
    },
    "time":1524448722000、
    "code":6304、
    "message":"tsl parse: params not exist -> type"
} 

以下の点にご注意ください。

• value: オブジェクト型。 イベントの出力パラメーター。

• time: ロングタイプ。 イベントがいつ生成されたかを示すタイムスタンプ。

• code: 整数型。 データの検証に失敗した場合に返されるエラーコード。 詳細については、「デバイスのエラーコード」をご参照ください。

• message: String型。 データの検証に失敗した場合に返されるエラーメッセージ。 メッセージには、失敗の原因と無効なパラメーターに関する情報が含まれています。

時間

Long

イベントが送信された時刻。 デバイスがタイムスタンプを送信しない場合、IoT Platformがメッセージを受信したときを示すタイムスタンプが使用されます。

パラメーター

データ型

説明

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

instanceId

String

デバイスが属するインスタンスのID。

requestId

String

アイテム

オブジェクト

デバイスによって送信されたデータ。

パワー

String

プロパティの識別子。 プロパティの詳細については、製品のTSLモデルを参照してください。

{
    "items":{
        "test:Power":[
            {
                "value":"on",
                "time":1510799670074
            },
            {
                "value": "off" 、 
                "time": 1524448722001
            }
        ],
        "test:WF":[
            {
                "value": 3、 
                "time": 1524448722000
            },
            {
                "value": 4、 
                "time": 1524448722009
            }
        ]
    }
}

WF

値

TSL定義の対象

プロパティの値

時間

Long

プロパティが提出された時刻。 デバイスがタイムスタンプを送信しない場合、IoT Platformがメッセージを受信したときを示すタイムスタンプが使用されます。

パラメーター

データ型

説明

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

instanceId

String

デバイスが属するインスタンスのID。

requestId

String

アイテム

オブジェクト

デバイスによって送信されたデータ。

alarmEvent

List

イベントの識別子。

値

オブジェクト

イベントのパラメーター。

例: PowerとWF。

時間

Long

イベントが送信された時刻。 デバイスがタイムスタンプを送信しない場合、IoT Platformがメッセージを受信したときを示すタイムスタンプが使用されます。

パラメーター

データ型

説明

アクション

String

• create: デバイスを作成します。

• delete: デバイスを削除します。

• enable: デバイスを有効にします。

• disable: デバイスを無効にします。

iotId

String

IoT Platformのデバイスの一意の識別子。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

deviceSecret

String

デバイスのDeviceSecret。 このパラメーターは、actionパラメーターがcreateに設定されている場合にのみ含まれます。

messageCreateTime

Integer

メッセージがいつ生成されたかを示すタイムスタンプ。 単位：ミリ秒。

パラメーター

データ型

説明

アクション

String

• create: トポロジ関係を作成します。

• delete: トポロジ関係を削除します。

• enable: トポロジ関係を有効にします。

• disable: トポロジ関係を無効にします。

gwIotId

String

IoT Platformのゲートウェイの一意の識別子。

gwProductKey

String

ゲートウェイが属する製品の一意の識別子。

gwDeviceName

String

ゲートウェイの名前。

デバイス

オブジェクト

トポロジ関係が変更されたサブデバイス。

iotId

String

IoT Platformのサブデバイスの一意の識別子。

productKey

String

サブデバイスが属する製品の一意の識別子。

deviceName

String

サブデバイスの名前

messageCreateTime

Integer

メッセージが生成されたときのタイムスタンプ。 単位：ミリ秒。

パラメーター

データ型

説明

gwIotId

String

IoT Platformのゲートウェイの一意の識別子。

gwProductKey

String

ゲートウェイが属する製品の一意の識別子。

gwDeviceName

String

ゲートウェイの名前。

デバイス

オブジェクト

ゲートウェイによって検出されたサブデバイス

iotId

String

IoT Platformのサブデバイスの一意の識別子。

productKey

String

サブデバイスが属する製品の一意の識別子。

deviceName

String

サブデバイスの名前

パラメーター

データ型

説明

gmtCreate

Long

UTC形式のタイムスタンプ。

iotId

String

IoT Platformのデバイスの一意の識別子。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

requestId

String

コード

Integer

デバイスによって返される応答コード。 詳細については、「応答コード」の表をご参照ください。

メッセージ

String

デバイスによって返されるメッセージ。

トピック

String

ダウンストリームリクエストの送信に使用されるトピックに関する情報。

データ

オブジェクト

デバイスによって返されるデータ。 デバイスがAlinkデータを返す場合、データを解析する必要はありません。 デバイスがパススルーデータを返す場合は、スクリプトを使用してデータを解析する必要があります。

checkFailedData

オブジェクト

検証に失敗したデータ。

値

TSL定義の対象

値の検証に失敗したプロパティまたはサービスパラメータ。

例: PicID。

コード

Integer

データの検証に失敗した場合に返されるエラーコード。 詳細については、「デバイスのエラーコード」をご参照ください。

メッセージ

String

データの検証に失敗した場合に返されるエラーメッセージ。 エラーメッセージには、失敗の原因と無効なパラメーターに関する情報が含まれています。

コード

メッセージ

説明

200

success

リクエストは成功です。

400

request error

内部エラーが発生しました。

460

request parameter error

リクエストパラメーターが無効で、デバイスがパラメーターの検証に失敗しました。

429

too many requests

指定された期間内のリクエストの最大数に達しました。

9200

デバイスがアクティブ化されていない

デバイスは起動していません。

9201

device offline

デバイスがIoT Platformから切断されました。

403

request forbidden

料金滞納のため、リクエストは拒否されます。

パラメーター

データ型

説明

iotId

String

IoT Platformのデバイスの一意の識別子。

requestId

String

メッセージのID。 有効な値: 0 ~ 4294967295 各メッセージIDは、デバイスに対して一意である必要があります。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

gmtCreate

Long

メッセージが生成された時刻。

deviceType

String

デバイスの製品カテゴリ。

IoT Platformでプロダクトを作成するときに、プロダクトカテゴリを指定できます。 詳細については、「プロダクトの作成」または「CreateProduct」をご参照ください。

アイテム

オブジェクト

デバイスによって送信されたデータ。

パワー

String

プロパティの識別子。 プロパティの詳細については、製品のTSLモデルを参照してください。

{
    "items":{
        "test:Power":{
            "value":"on",
            "time":1510799670074
        },
        "test: ポジション":{
            "time":1510292697470,
            "value":{
                "latitude":39.9,
                "longitude":116.38
            }
        }
    }
}

位置

attribute_8

checkFailedData

オブジェクト

検証に失敗したデータ。

値

TSL定義の対象

プロパティの値

時間

Long

プロパティが提出された時刻。 デバイスがタイムスタンプを送信しない場合、IoT Platformがメッセージを受信したときを示すタイムスタンプが使用されます。

コード

Integer

データの検証に失敗した場合に返されるエラーコード。 詳細については、「デバイスのエラーコード」をご参照ください。

メッセージ

String

データの検証に失敗した場合に返されるエラーメッセージ。 エラーメッセージには、失敗の原因と無効なパラメーターに関する情報が含まれています。

パラメーター

データ型

説明

識別子

String

イベントの識別子。

"test:identifier":"BrokenInfo" 、

name

String

イベント名。

タイプ

String

イベントのタイプ。 サポートされているイベントの種類については、製品のTSLモデルを参照してください。

iotId

String

IoT Platformのデバイスの一意の識別子。

requestId

String

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

gmtCreate

Long

メッセージが生成された時刻。

値

オブジェクト

イベントの出力パラメーター。 例: パワーとポジション。

{
    "パワー":"オン" 、
    "Position":{
        "latitude":39.9,
        "longitude":116.38
    }
}

checkFailedData

オブジェクト

検証に失敗したデータ。

出力パラメーターの検証に失敗した場合、checkFailedDataパラメーターには次のパラメーターが含まれます。

{
    "value":{
        "パワー":"オン" 、
        "Position":{
            "latitude":39.9,
            "longitude":116.38
        }
    },
    "time":1524448722000、
    "code":6304、
    "message":"tsl parse: params not exist -> type"
} 

以下の点にご注意ください。

• value: オブジェクト型。 イベントの出力パラメーター。

• time: ロングタイプ。 イベントがいつ生成されたかを示すタイムスタンプ。

• code: 整数型。 データの検証に失敗した場合に返されるエラーコード。 詳細については、「デバイスのエラーコード」をご参照ください。

• message: String型。 データの検証に失敗した場合に返されるエラーメッセージ。 メッセージには、失敗の原因と無効なパラメーターに関する情報が含まれています。

時間

Long

イベントが送信された時刻。 デバイスがタイムスタンプを送信しない場合、IoT Platformがメッセージを受信したときを示すタイムスタンプが使用されます。

パラメーター

データ型

説明

iotId

String

IoT Platformのデバイスの一意の識別子。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

moduleName

String

OTAモジュールの名前。

status

String

更新のステータス。

• SUCCEEDED: 更新タスクは成功です。

• FAILED: 更新タスクが失敗しました。

• : 更新タスクがキャンセルされました。

messageCreateTime

Long

メッセージが生成されたときのタイムスタンプ。 単位：ミリ秒。

srcVersion

String

更新前のファームウェアバージョン。

destVersion

String

更新後のファームウェアバージョン。

desc

String

更新の説明。The description of the update.

jobId

String

更新バッチのID。 このパラメーターは、更新バッチを一意に識別するために使用されます。

taskId

String

デバイス更新レコードの一意の識別子。

パラメーター

データ型

説明

iotId

String

IoT Platformのデバイスの一意の識別子。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

moduleName

String

OTAモジュールの名前。

status

String

更新のステータス。 値はIN_PROGRESSに固定されています。

ステップ

Integer

更新の進行状況。

messageCreateTime

Long

メッセージに対して生成されたタイムスタンプ。 単位：ミリ秒。

srcVersion

String

更新前のファームウェアバージョン。

destVersion

String

更新後のファームウェアバージョン。

desc

String

更新の説明。The description of the update.

jobId

String

更新バッチのID。 このパラメーターは、更新バッチを一意に識別するために使用されます。

taskId

String

デバイス更新レコードの一意の識別子。

パラメーター

データ型

説明

iotId

String

IoT Platformのデバイスの一意の識別子。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

moduleName

String

OTAモジュールの名前。

moduleVersion

String

モジュールのバージョン番号。

messageCreateTime

Long

メッセージに対して生成されたタイムスタンプ。 単位：ミリ秒。

パラメーター

データ型

説明

productKey

String

デバイスが属するプロダクトの一意の識別子。

moduleName

String

OTAモジュールの名前。

packageId

String

更新パッケージのID。 このパラメーターの値は、CreateOTAFirmware操作を呼び出して更新パッケージを作成したときに返されるFirmwareIdパラメーターの値と同じです。

jobId

String

更新バッチのID。 このパラメーターは、更新バッチを一意に識別するために使用されます。

state

String

更新バッチのステータス。 有効な値：

• PLANNED: 更新は開始されません。

• IN_PROGRESS: アップデートは実行中です。

• 完了: 更新は完了です。

• キャンセル済み: 更新がキャンセルされました。

• UNFINISH: 更新が完了していません。

  Enterprise Editionインスタンスの更新試行回数が上限に達した場合、更新バッチはUNFINISH状態になります。

messageCreateTime

Long

メッセージに対して生成されたタイムスタンプ。 単位：ミリ秒。

パラメーター

データ型

説明

アクション

String

タグのタイプが変わります。 有効な値：

• UPDATE: タグが更新されるか、タグが作成されます。

• DELETE: タグが削除されました。

• DELETEALL: すべてのタグが削除されます。

iotId

String

IoT Platformのデバイスの一意の識別子。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

deletedAttrKeyList

List

削除されたタグのキー。

このパラメーターは、actionパラメーターがDELETEに設定されている場合にのみ使用できます。

値

List

タグのデータ。

attrKey

String

タグのキー。

attrValue

String

タグの値。

messageCreateTime

Long

メッセージに対して生成されたタイムスタンプ。 単位：ミリ秒。

パラメーター

データ型

説明

jobId

String

タスクのID。

status

String

タスクの実行ステータス 有効な値：

• GRAY_EXECUTING: 部分データの移行中です。

• GRAY_FINISHED: 部分データが移行されます。

• ALL_EXECUTING: タスクは実行中です。

• ALL_FINISHED: タスクは完了です。

• ALL_PAUSE: タスクが一時停止されます。

• ROLL_BACK_EXECUTING: タスクはロールバック中です。

• ROLL_BACK_PAUSE: ロールバックは一時停止しています。

messageCreateTime

Long

メッセージに対して生成されたタイムスタンプ。 単位：ミリ秒。

タイプ

String

タスクの ID を設定します。 値はINSTANCE_UPGRADEに固定されています。

sourceInstance

String

データの移行元のパブリックインスタンスのID。 パブリックインスタンスが以前のバージョンの場合、値はiotx-oxssharez200です。

IoT Platformインスタンスの詳細については、「概要」をご参照ください。

targetInstance

String

データの移行先のEnterprise EditionインスタンスのID。

successDevices

List

移行されるデバイスに関する情報。

• フェーズデータ移行タスクまたはフルスケールデータ移行タスクを実行する場合、パラメーターの値には、パブリックインスタンスからEnterprise Editionインスタンスに移行されるデバイスに関する情報が含まれます。

• データ移行タスクをロールバックする場合、パラメーターの値には、Enterprise Editionインスタンスからパブリックインスタンスに移行されるデバイスに関する情報が含まれます。

productKey

String

デバイスが属するプロダクトの一意の識別子。

deviceName

String

デバイスのDeviceName。

iotId

String

IoT Platformのデバイスの一意の識別子。