IoT Platform:データ形式

メッセージ転送および生デバイス通信のためのトピック

通信トピックの定義、使用方法、分類については、「トピックとは」をご参照ください。

以下の表に、転送トピックと対応する生デバイス通信トピックを示します。

デバイスのオンライン・オフラインステータス

トピック：/as/mqtt/status/${productKey}/${deviceName}

このトピックを通じて、デバイスのオンラインまたはオフラインステータスを取得します。

デバイスがオンラインになった場合のデータ形式：

{
    "status":"online",
    "iotId":"4z819VQHk6VSLmmBJfrf00107e****",
    "productKey":"al12345****",
    "deviceName":"deviceName1234",
    "time":"2018-08-31 15:32:28.205",
    "utcTime":"2018-08-31T07:32:28.205Z",
    "lastTime":"2018-08-31 15:32:28.195",
    "utcLastTime":"2018-08-31T07:32:28.195Z",
    "clientIp":"192.0.2.1"
}

デバイスがオフラインになった場合のデータ形式：

{
    "status":"offline",
    "iotId":"4z819VQHk6VSLmmBJfrf00107e****",
    "offlineReasonCode":427,
    "productKey":"al12345****",
    "deviceName":"deviceName1234",
    "time":"2018-08-31 15:32:28.205",
    "utcTime":"2018-08-31T07:32:28.205Z",
    "lastTime":"2018-08-31 15:32:28.195",
    "utcLastTime":"2018-08-31T07:32:28.195Z",
    "clientIp":"192.0.2.1"
}

パラメーターの説明：

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

トピック：/${productKey}/${deviceName}/thing/event/property/post

このトピックを使用して、デバイスが送信したプロパティを取得します。

データ形式：

{
    "iotId":"4z819VQHk6VSLmmBJfrf00107e****",
    "requestId":"2",
    "productKey":"al12345****",
    "deviceName":"deviceName1234",
    "gmtCreate":1510799670074,
    "deviceType":"Ammeter",
    "items":{
        "Power":{
            "value":"on",
            "time":1510799670074
        },
        "Position":{
            "time":1510292697470,
            "value":{
                "latitude":39.9,
                "longitude":116.38
            }
        }
    },
    "checkFailedData":{
        "attribute_8":{
            "time": 1510292697470,
            "value": 715665571,
            "code":6304,
            "message":"tsl parse: params not exist -> attribute_8"
        }
    }
}

パラメーターの説明：

{
    "items":{
        "test:Power":{
            "value":"on",
            "time":1510799670074
        },
        "test:Position":{
            "time":1510292697470,
            "value":{
                "latitude":39.9,
                "longitude":116.38
            }
        }
    }
}

デバイスイベントの送信

トピック：/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/post

このトピックを使用して、デバイスが送信したイベント情報を取得します。

データ形式：

{
    "identifier":"BrokenInfo",
    "name":"Damage Rate Submission",
    "type":"info",
    "iotId":"4z819VQHk6VSLmmBJfrf00107e****",
    "requestId":"2",
    "productKey":"X5eCzh6****",
    "deviceName":"5gJtxDVeGAkaEztpisjX",
    "gmtCreate":1510799670074,
    "value":{
        "Power":"on",
        "Position":{
            "latitude":39.9,
            "longitude":116.38
        }
    },
    "checkFailedData":{},
    "time":1510799670074
}

パラメーターの説明：

"test:identifier":"BrokenInfo",

{
    "Power":"on",
    "Position":{
        "latitude":39.9,
        "longitude":116.38
    }
}

{
    "value":{
        "Power":"on",
        "Position":{
            "latitude":39.9,
            "longitude":116.38
        }
    },
    "time":1524448722000,
    "code":6304,
    "message":"tsl parse: params not exist -> type"
}

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

トピック：/${productKey}/${deviceName}/thing/property/batch/post

このトピックを使用して、デバイスが一括送信したプロパティを取得します。

データ形式：

{
    "productKey": "al12345****",
    "deviceName": "deviceName1234",
    "instanceId": "iot-0***",
    "requestId": "2",
    "items": {
        "Power": [
            {
                "value": "on",
                "time": 1524448722000
            },
            {
                "value": "off",
                "time": 1524448722001
            }
        ],
        "WF": [
            {
                "value": 3,
                "time": 1524448722000
            },
            {
                "value": 4,
                "time": 1524448722009
            }
        ]
    }
}

パラメーターの説明：

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

デバイスイベントの一括送信

トピック：/${productKey}/${deviceName}/thing/event/batch/post

このトピックを使用して、デバイスが一括送信したイベントを取得します。

データ形式：

{
    "productKey": "al12345****",
    "deviceName": "deviceName1234",
    "instanceId": "iot-0***",
    "requestId": "2",
    "items": {
        "alarmEvent": [
            {
                "value": {
                    "Power": "on",
                    "WF": "2"
                },
                "time": 1524448722000
            },
            {
                "value": {
                    "Power": "on",
                    "WF": "2"
                },
                "time": 1524448723000
            }
        ]
    }
}

パラメーターの説明：

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

トピック：/${productKey}/${deviceName}/thing/lifecycle

このトピックを使用して、デバイスが作成、削除、有効化、無効化された際に生成されるメッセージを受信します。

データ形式：

{
    "action": "create|delete|enable|disable",
    "iotId": "4z819VQHk6VSLmmBJfrf00107e****",
    "productKey": "al5eCzh****",
    "deviceName": "5gJtxDVeGAkaEztpisjX",
    "deviceSecret": "wsde***", 
    "messageCreateTime": 1510292739881 
}

パラメーターの説明：

デバイストポロジーの変更

トピック：/${productKey}/${deviceName}/thing/topo/lifecycle

このトピックを使用して、サブデバイスとゲートウェイ間のトポロジー関係の追加および削除に関する情報を受信します。

データ形式：

{
    "action" : "create|delete|enable|disable",
    "gwIotId": "dfaejVQHk6VSLmmBJfrf00107e****",
    "gwProductKey": "al5eCzh****",
    "gwDeviceName": "deviceName1234",
    "devices": [
        {
            "iotId": "4z819VQHk6VSLmmBJfrf00107e****",
            "productKey": "ala4Czh****",
            "deviceName": "deviceName1234"
        }
    ],
    "messageCreateTime": 1510292739881
}

パラメーターの説明：

ゲートウェイによるサブデバイスの検出

トピック：/${productKey}/${deviceName}/thing/list/found

一部のシナリオでは、ゲートウェイがサブデバイスを検出し、その情報を報告できます。このトピックを使用して、報告された情報を取得できます。

データ形式：

{
    "gwIotId":"dfaew9VQHk6VSLmmBJfrf00107e****",
    "gwProductKey":"al12345****",
    "gwDeviceName":"deviceName1234",
    "devices":[
        {
            "iotId":"4z819VQHk6VSLmmBJfrf00107e****",
            "productKey":"alr56g9****",
            "deviceName":"deviceName1234"
        }
    ]
}

パラメーターの説明：

ダウンストリームコマンドの結果

トピック：/${productKey}/${deviceName}/thing/downlink/reply/message

デバイスが非同期プロパティ設定およびサービス呼び出しコマンドを処理した後に返される結果を取得します。コマンド送信時にエラーが発生した場合、このトピックはエラーメッセージも返します。

データ形式：

{
    "gmtCreate":1510292739881,
    "iotId":"4z819VQHk6VSLmmBJfrf00107e****",
    "productKey":"al12355****",
    "deviceName":"deviceName1234",
    "requestId":"2",
    "code":200,
    "message":"success",
    "topic":"/sys/al12355****/deviceName1234/thing/service/property/set",
    "data":{},
    "checkFailedData":{
        "value": {
            "PicID": "15194139"
        },
        "code":6304,
        "message":"tsl parse: params not exist -> PicID"
    }
}

パラメーターの説明：

これらのエラーを解決するには、「デバイスのエラーコード」をご参照ください。

履歴プロパティの送信

トピック：/${productKey}/${deviceName}/thing/event/property/history/post

このトピックを使用して、デバイスが送信した TSL モデルの履歴プロパティデータを取得します。

データ形式：

{
    "iotId":"4z819VQHk6VSLmmBJfrf00107e****",
    "requestId":"2",
    "productKey":"12345****",
    "deviceName":"deviceName1234",
    "gmtCreate":1510799670074,
    "deviceType":"Ammeter",
    "items":{
        "Power":{
            "value":"on",
            "time":1510799670074
        },
        "Position":{
            "time":1510292697470,
            "value":{
                "latitude":39.9,
                "longitude":116.38
            }
        }
    },
    "checkFailedData":{
        "attribute_8":{
            "time": 1510292697470,
            "value": 715665571,
            "code":6304,
            "message":"tsl parse: params not exist -> attribute_8"
        }
    }
}

パラメーターの説明：

{
    "items":{
        "test:Power":{
            "value":"on",
            "time":1510799670074
        },
        "test:Position":{
            "time":1510292697470,
            "value":{
                "latitude":39.9,
                "longitude":116.38
            }
        }
    }
}

履歴イベントの送信

トピック：/${productKey}/${deviceName}/thing/event/${tsl.event.identifier}/history/post

このトピックを使用して、デバイスが送信した履歴イベントデータを取得します。

データ形式：

{
    "identifier":"BrokenInfo",
    "name":"Damage Rate Submission",
    "type":"info",
    "iotId":"4z819VQHk6VSLmmBJfrf00107e***",
    "requestId":"2",
    "productKey":"X5eCzh6***",
    "deviceName":"5gJtxDVeGAkaEztpisjX",
    "value":{
        "Power":"on",
        "Position":{
            "latitude":39.9,
            "longitude":116.38
        }
    },
    "checkFailedData":{},
    "time":1510799670074
}

パラメーターの説明：

"test:identifier":"BrokenInfo",

{
    "Power":"on",
    "Position":{
        "latitude":39.9,
        "longitude":116.38
    }
}

{
    "value":{
        "Power":"on",
        "Position":{
            "latitude":39.9,
            "longitude":116.38
        }
    },
    "time":1524448722000,
    "code":6304,
    "message":"tsl parse: params not exist -> type"
}

ファームウェアアップデートのステータス通知

トピック：/${productKey}/${deviceName}/ota/upgrade

デバイスのアップデートが成功または失敗したことを示すファームウェアアップデートステータスメッセージを受信します。

データ形式：

{
    "iotId": "4z819VQHk6VSLmmBJfrf00107e****",
    "productKey": "X5eCzh6****",
    "deviceName": "deviceName1234",
    "moduleName": "default",
    "status": "SUCCEEDED|FAILED|CANCELED",
    "messageCreateTime": 1571323748000,
    "srcVersion": "1.0.1",
    "destVersion": "1.0.2",
    "desc": "success",
    "jobId": "wahVIzGkCMuAUE2gDERM02****",
    "taskId": "y3tOmCDNgpR8F9jnVEzC01****"
}

パラメーターの説明：

ファームウェアアップデートの進捗通知

トピック：/${productKey}/${deviceName}/ota/progress/post

このトピックを使用して、ファームウェアアップデートの進捗メッセージを取得します。

データ形式：

{
    "iotId": "4z819VQHk6VSLmmBJfrf00107e****",
    "productKey": "X5eCzh6****",
    "deviceName": "deviceName1234",
    "moduleName":"default",
    "status":"IN_PROGRESS",
    "step": "90",
    "messageCreateTime": 1571323748000,
    "srcVersion":"1.0.1",
    "destVersion":"1.0.2",
    "desc": "success",
    "jobId": "wahVIzGkCMuAUE2gDERM02****",
    "taskId": "y3tOmCDNgpR8F9jnVEzC01****"
}

パラメーターの説明：

OTA モジュールバージョン変更通知

トピック：/${productKey}/${deviceName}/ota/version/post

このトピックを使用して、デバイスが報告する OTA モジュールバージョン番号を取得します。デバイスが新しい OTA モジュールバージョン番号を報告すると、メッセージが転送されます。

データ形式：

{
    "iotId": "4z819VQHk6VSLmmBJfrf00107e****",
    "deviceName": "deviceName1234",
    "productKey": "X5eCzh6****",
    "moduleName": "BarcodeScanner",
    "moduleVersion": "1.0.3",
    "messageCreateTime": 1571323748000
}

パラメーターの説明：

ファームウェアアップデート一括処理のステータス通知

トピック：/${productKey}/${packageId}/${jobId}/ota/job/status

このトピックを使用して、ファームウェアアップデート一括処理のステータス変更メッセージを取得します。

データ形式：

{
    "productKey": "X5eCzh6****",
    "moduleName": "BarcodeScanner",
    "packageId": "wahVIzGkCMuAUE2***",
    "jobId": "wahVIzGkCMuAUE2gDERM02****",
    "state": "IN_PROGRESS",
    "messageCreateTime": 1571323748000
}

パラメーターの説明：

デバイスタグの変更

トピック：/${productKey}/${deviceName}/thing/deviceinfo/update

このトピックを使用して、デバイスタグの変更に関する情報を取得します。

データ形式：

{
    "action": "UPDATE|DELETE|DELETEALL"
    "iotId": "4z819VQHk6VSLmmBJfrf00107e****",
    "productKey": "X5eCzh6****",
    "deviceName": "deviceName1234",
    "deletedAttrKeyList": ["abc", "def", "rng"],
    "value": [
        {
            "attrKey": "tagKey",
            "attrValue": "tagValue"
        }
    ],
    "messageCreateTime": 1510799670074
}

パラメーターの説明：

デバイスジョブステータス通知

トピック：/sys/uid/${uid}/job/${jobId}/lifecycle

このトピックを使用して、デバイスジョブのステータス変更メッセージを受信します。デバイスジョブには、一括プロパティ設定ジョブ、一括サービス呼び出しジョブ、カスタムジョブが含まれます。

トピック内の ${uid} は、お客様の Alibaba Cloud アカウント ID です。ID を確認するには、IoT Platform コンソール にログインし、プロフィール画像をクリックして セキュリティ設定 ページに移動してください。

データ形式：

{
    "jobId": "4z819VQHk6VSLmm***ee200",
    "jobType": "CUSTOM_JOB",
    "status": "INITIALIZING",
    "messageCreateTime": 1510292739881
}

パラメーターの説明：

インスタンス移行ジョブステータス通知

トピック：/sys/uid/{uid}/distribution/{jobId}/lifecycle

このトピックを使用して、インスタンス移行ジョブのステータス変更メッセージを取得します。

トピック内の ${uid} は、お客様の Alibaba Cloud アカウント ID です。アカウント ID を確認するには、IoT Platform コンソール にログインし、プロフィール画像にマウスポインターを合わせて アカウント ID を確認してください。

データ形式：

{
    "jobId": "4z819VQHk6VSLmmxxxxxxxxxxee200",
    "status": "GRAY_EXECUTING",
    "messageCreateTime": 1510292739881,
    "type":"INSTANCE_UPGRADE",
    "sourceInstance":"iotx-oxssharez200",
    "targetInstance":"iot-es5v4***",
    "successDevices":[
        {
            "productKey":"al12***",
            "deviceName":"deviceName1",
            "iotId":"4z81frf00107e***"
        }
    ]
}

パラメーターの説明：