遠程配置 - IoT Platform

本文檔介紹裝置主動請求配置資訊和物聯網平台推送配置資訊的Topic及Alink資料格式。

遠程配置的具體使用方法，請參見使用者指南中遠程配置文檔。

裝置主動請求配置資訊

上行

請求Topic：/sys/${productKey}/${deviceName}/thing/config/get
響應Topic：/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號。String類型的數字，取值範圍`0`~`4294967295`，且每個訊息ID在當前裝置中具有唯一性。
version	String	協議版本號碼，目前協議版本號碼唯一取值為`1.0`。
sys	Object	擴充功能的參數，其下包含各功能欄位。說明使用裝置端SDK開發時，如果未設定擴充功能，則無此參數，相關功能保持預設配置。
ack	Integer	sys下的擴充功能欄位，表示是否返迴響應資料。 1：雲端返迴響應資料。 0：雲端不返迴響應資料。重要該功能配置說明，請參見物模型使用樣本。如果未配置該功能，則無此參數，雲端預設返迴響應資料。
configScope	String	配置範圍，目前只支援產品維度配置。取值：`product`。
getType	String	擷取配置類型。目前支援檔案類型，取值：`file`。
method	String	要求方法，取值：`thing.config.get`。
configId	String	設定檔的ID。
configSize	Long	設定檔大小，按位元組計算。
sign	String	簽名。
signMethod	String	簽名方法，僅支援Sha256。
url	String	儲存設定檔的Object Storage Service地址。
code	Integer	結果碼。返回200表示成功，返回其他狀態代碼，表示失敗。具體請參見裝置端通用code。

錯誤碼

錯誤碼	訊息	描述
6713	thing config function is not available	產品的遠程配置功能不可用，需要在物聯網平台控制台，監控營運 > 遠程配置開啟配置開關。
6710	no data	沒有配置的資料。

配置推送

下行

請求Topic：/sys/${productKey}/${deviceName}/thing/config/push
響應Topic：/sys/${productKey}/${deviceName}/thing/config/push_reply

裝置訂閱該Topic後，您在物聯網控制台批量推送配置資訊時，物聯網平台採用非同步推送方式向裝置推送資訊。

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號。String類型的數字，取值範圍`0`~`4294967295`，且每個訊息ID在當前裝置中具有唯一性
version	String	協議版本號碼，目前協議版本號碼唯一取值為`1.0`。
configScope	String	配置範圍，目前只支援產品維度配置。取值：`product`。
getType	String	擷取配置類型，目前支援檔案類型，取值：`file`。
configId	String	配置的ID。
configSize	Long	配置大小，按位元組計算。
sign	String	簽名。
signMethod	String	簽名方法，僅支援sha256。
url	String	儲存設定檔的Object Storage Service地址。
method	String	要求方法，取值：`thing.config.push`。
code	Integer	結果資訊，具體請參見裝置端通用code。

您可以使用規則引擎資料流轉功能，將裝置返回的響應結果轉寄至其他Topic和其他阿里雲服務中。具體的裝置響應資料Topic和資料格式請參見裝置下行指令結果資料流轉。