本文檔介紹設備主動請求配置信息和物聯網平臺推送配置信息的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"
  }
}

參數說明

參數類型說明
idString消息ID號。String類型的數字,取值范圍0~4294967295,且每個消息ID在當前設備中具有唯一性。
versionString協議版本號,目前協議版本號唯一取值為1.0
sysObject擴展功能的參數,其下包含各功能字段。
說明 使用設備端SDK開發時,如果未設置擴展功能,則無此參數,相關功能保持默認配置。
ackIntegersys下的擴展功能字段,表示是否返回響應數據。
  • 1:云端返回響應數據。
  • 0:云端不返回響應數據。
重要 該功能配置說明,請參見物模型使用示例

如果未配置該功能,則無此參數,云端默認返回響應數據。

configScopeString配置范圍, 目前只支持產品維度配置。 取值:product
getTypeString獲取配置類型。 目前支持文件類型,取值:file
methodString請求方法,取值:thing.config.get
configIdString配置文件的ID。
configSizeLong配置文件大小,按字節計算。
signString簽名。
signMethodString簽名方法,僅支持Sha256。
urlString存儲配置文件的對象存儲(OSS)地址。
codeInteger結果碼。返回200表示成功,返回其他狀態碼,表示失敗。具體請參見設備端通用code

錯誤碼

錯誤碼消息描述
6713thing config function is not available產品的遠程配置功能不可用,需要在物聯網平臺控制臺對應實例的監控運維 > 遠程配置打開配置開關。
6710no 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": {}
}

參數說明

參數類型說明
idString

消息ID號。String類型的數字,取值范圍0~4294967295,且每個消息ID在當前設備中具有唯一性

versionString協議版本號,目前協議版本號唯一取值為1.0
configScopeString配置范圍, 目前只支持產品維度配置。 取值:product
getTypeString獲取配置類型,目前支持文件類型,取值:file
configIdString配置的ID。
configSizeLong配置大小,按字節計算。
signString簽名。
signMethodString簽名方法,僅支持sha256。
urlString存儲配置文件的對象存儲(OSS)地址。
methodString請求方法,取值:thing.config.push
codeInteger結果信息, 具體請參見設備端通用code

您可以使用規則引擎數據流轉功能,將設備返回的響應結果轉發至其他Topic和其他阿里云服務中。具體的設備響應數據Topic和數據格式請參見設備下行指令結果數據流轉