リモート構成のトピックと Alink データ形式 | IoT Platform - IoT Platform

このドキュメントでは、デバイスからの構成リクエストと IoT Platform からの構成プッシュに関するトピックおよび Alink データ形式について説明します。

詳しい使用手順については、ユーザーガイドの「リモート構成」をご参照ください。

デバイスからの構成リクエスト

アップリンク

リクエストトピック：/sys/${productKey}/${deviceName}/thing/config/get
レスポンストピック：/sys/${productKey}/${deviceName}/thing/config/get_reply

Alink リクエストデータ形式

{
  "id": 123,
  "version": "1.0",
  "sys":{
      "ack":0
  },
  "params": {
    "configScope": "product",
    "getType": "file"
  },
  "method": "thing.config.get"
}

Alink レスポンスデータ形式

{
  "id": "123",
  "version": "1.0",
  "code": 200,
  "data": {
    "configId": "123dagdah",
    "configSize": 1234565,
    "sign": "123214adfadgadg",
    "signMethod": "Sha256",
    "url": "https://iotx-config.oss-cn-shanghai.aliyuncs.com/nopoll_0.4.4.tar.gz?Expires=1502955804&OSSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Signature=XfgJu7P6DWWejstKJgXJEH0qAKU%3D&security-token=CAISuQJ1q6Ft5B2yfSjIpK6MGsyN1Jx5jo6mVnfBglIPTvlvt5D50Tz2IHtIf3NpAusdsv03nWxT7v4flqFyTINVAEvYZJOPKGrGR0DzDbDasumZsJbo4f%2FMQBqEaXPS2MvVfJ%2BzLrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fr6%2F5gdc9FcQSkL0B8ZrFsKxBltdUROFbIKP%2BpKWSKuGfLC1dysQcO1wEP4K%2BkkMqH8Uic3h%2Boy%2BgJt8H2PpHhd9NhXuV2WMzn2%2FdtJOiTknxR7ARasaBqhelc4zqA%2FPPlWgAKvkXba7aIoo01fV4jN5JXQfAU8KLO8tRjofHWmojNzBJAAPpYSSy3Rvr7m5efQrrybY1lLO6iZy%2BVio2VSZDxshI5Z3McKARWct06MWV9ABA2TTXXOi40BOxuq%2B3JGoABXC54TOlo7%2F1wTLTsCUqzzeIiXVOK8CfNOkfTucMGHkeYeCdFkm%2FkADhXAnrnGf5a4FbmKMQph2cKsr8y8UfWLC6IzvJsClXTnbJBMeuWIqo5zIynS1pm7gf%2F9N3hVc6%2BEeIk0xfl2tycsUpbL2FoaGk6BAF8hWSWYUXsv59d5Uk%3D",
    "getType": "file"
  }
}

パラメーター

パラメーター	タイプ	説明
id	String	メッセージ ID。デバイスごとに一意の数値文字列で、範囲は `0`～`4294967295` です。
version	String	プロトコルバージョン。`1.0` に設定します。
sys	オブジェクト	拡張フィーチャのパラメータ。The parameter for extended features. 値には、各フィーチャのフィールドが含まれます。説明デバイスSDKを使用してデバイス機能を開発するときに拡張機能が設定されていない場合、このパラメーターは使用できません。拡張機能はデフォルトの設定を使用します。
ack	Integer	sysパラメーターの拡張機能フィールド。このフィールドは、IoT Platformが登録要求の応答データを返すかどうかを指定します。有効な値： 1: IoT Platformは応答データを返します。 0: IoT Platformは応答データを返しません。重要パラメーターの詳細については、「TSLモデルの使用方法の例」をご参照ください。機能が設定されていない場合、このパラメーターは使用できません。デフォルトでは、IoT Platformは登録リクエストの応答データを返します。
configScope	String	構成スコープ。プロダクトレベルのみがサポートされています。`product` に設定します。
getType	String	構成タイプ。ファイルのみがサポートされています。`file` に設定します。
method	String	リクエストメソッド。`thing.config.get` に設定します。
configId	String	構成ファイルの ID。
configSize	Long	構成ファイルのサイズ (バイト単位)。
sign	String	署名。
signMethod	String	署名方式。`Sha256` のみがサポートされています。
url	String	構成ファイルの OSS URL。
code	Integer	結果コード。200 は成功を示します。その他のコードは、「デバイス側の共通コード」に記載されています。

エラーコード

エラーコード	メッセージ	説明
6713	thing config function is not available	プロダクトのリモート構成機能が有効になっていません。IoT Platform コンソール、[モニタリング] > [リモート構成] に移動して有効化してください。
6710	no data	構成データが存在しません。

構成プッシュ

ダウンリンク

リクエストトピック：/sys/${productKey}/${deviceName}/thing/config/push
レスポンストピック：/sys/${productKey}/${deviceName}/thing/config/push_reply

デバイスがこのトピックをサブスクライブすると、コンソールでのバッチプッシュ実行時に、IoT Platform は非同期で構成情報をプッシュします。

Alink リクエストデータ形式

{
  "id": "123",
  "version": "1.0",
  "params": {
    "configId": "123dagdah",
    "configSize": 1234565,
    "sign": "123214adfadgadg",
    "signMethod": "Sha256",
    "url": "https://iotx-config.oss-cn-shanghai.aliyuncs.com/nopoll_0.4.4.tar.gz?Expires=1502955804&OSSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Signature=XfgJu7P6DWWejstKJgXJEH0qAKU%3D&security-token=CAISuQJ1q6Ft5B2yfSjIpK6MGsyN1Jx5jo6mVnfBglIPTvlvt5D50Tz2IHtIf3NpAusdsv03nWxT7v4flqFyTINVAEvYZJOPKGrGR0DzDbDasumZsJbo4f%2FMQBqEaXPS2MvVfJ%2BzLrf0ceusbFbpjzJ6xaCAGxypQ12iN%2B%2Fr6%2F5gdc9FcQSkL0B8ZrFsKxBltdUROFbIKP%2BpKWSKuGfLC1dysQcO1wEP4K%2BkkMqH8Uic3h%2Boy%2BgJt8H2PpHhd9NhXuV2WMzn2%2FdtJOiTknxR7ARasaBqhelc4zqA%2FPPlWgAKvkXba7aIoo01fV4jN5JXQfAU8KLO8tRjofHWmojNzBJAAPpYSSy3Rvr7m5efQrrybY1lLO6iZy%2BVio2VSZDxshI5Z3McKARWct06MWV9ABA2TTXXOi40BOxuq%2B3JGoABXC54TOlo7%2F1wTLTsCUqzzeIiXVOK8CfNOkfTucMGHkeYeCdFkm%2FkADhXAnrnGf5a4FbmKMQph2cKsr8y8UfWLC6IzvJsClXTnbJBMeuWIqo5zIynS1pm7gf%2F9N3hVc6%2BEeIk0xfl2tycsUpbL2FoaGk6BAF8hWSWYUXsv59d5Uk%3D",
    "getType": "file"
  },
  "method": "thing.config.push"
}

Alink レスポンスデータ形式

{
  "id": "123",
  "code": 200,
  "data": {}
}

パラメーター

パラメーター	タイプ	説明
id	String	メッセージ ID。デバイスごとに一意の数値文字列で、範囲は `0`～`4294967295` です。
version	String	プロトコルバージョン。`1.0` に設定します。
configScope	String	構成スコープ。プロダクトレベルのみがサポートされています。`product` に設定します。
getType	String	構成タイプ。ファイルのみがサポートされています。`file` に設定します。
configId	String	構成の ID。
configSize	Long	構成サイズ (バイト単位)。
sign	String	署名。
signMethod	String	署名方式。`Sha256` のみがサポートされています。
url	String	構成ファイルの OSS URL。
method	String	リクエストメソッド。`thing.config.push` に設定します。
code	Integer	結果コード。指定可能な値は、「デバイス側の共通コード」に記載されています。

ルールエンジンのデータ転送機能を使用して、デバイスのレスポンスを他のトピックや Alibaba Cloud サービスに転送できます。レスポンストピックと形式については、「ダウンリンク指示に対するデバイスレスポンスのデータ転送」をご参照ください。