设置期望属性

更新时间:2023-11-23 03:41:43下载pdf

本文介绍设置期望属性的 API。

接口描述

将设备属性下发指令存储在云端。当设备被唤醒 / 上线时,将指令下发到设备。该功能目前仅面向部分低功耗设备有效。

接口地址

POST: /v2.0/cloud/thing/{device_id}/shadow/properties/desired

请求参数

参数名类型参数位置是否必填说明
device_idStringpathtrue设备 ID。

body 说明

参数名类型参数位置是否必填说明
propertiesStringbodytrue设备支持的属性信息和设置的属性值。
durationLongbodytrue设备期望属性值的有效期。

返回参数

参数名类型说明
resultJSON返回数据集。
successBoolean操作是否成功。
  • true:操作成功。
  • false:操作失败。
tLong时间戳。
tidString链路 ID。

请求示例

POST: /v2.0/cloud/thing/vdevo1638******/shadow/properties/desired
{
  "properties": {
    "switch_1": true
  },
  "duration": 1000
}

返回示例

{
    "tid": "77a9807fb74411edb9d75a827c79edfd",
    "result": {
    },
    "t": 1677574021435,
    "success": true
}

错误码

参考 错误码

调用频率限制

参考 调用频率限制