简要描述：

  • 通过调用该接口进行设置属性期望值

接口版本：

版本号 制定人 制定日期 修订日期
1.0 张浩 2023-08-17

请求URL:

iot-platform/device-thing-model-server/v1/property/setDesired

请求方式：

  • POST

请求头：

参数名 是否必须 类型 说明
Content-Type 是 string 请求类型： application/json
Authorization 是 string 鉴权信息

请求示例:

{
    "productId":"AAcmXyLkS1",
    "deviceId":"339a0519f96b432092d6c3451b2dd53e",
    "property":{
        "default":{
            "color":{
                  "value":"red",
                  "time": 1692175019846
             }
        }
    }
}

请求参数:

参数名 是否必须 类型 说明
productId 是 string 产品ID,最长10位
deviceId 是 string 设备ID，最长32位
messageId String 否 消息ID，最长为64位字符，标识该消息的唯一ID，如不传则由服务端随机生成
property 是 Object 属性对象
property.{module} 是 Object 属性所属模块
property.{module}.{filed} 是 String 属性标识符
propert.{module}.{filed}.value Object 是 表示上报属性的值
propert.{module}.{filed}.time Long 否 表示属性更新的时间，unix时间戳毫秒值。

返回示例:

正确时返回:

{
  "code": 0,
  "msg": "ok",
  "err_code": 10000,
  "result":  {}
}

错误时返回:

{
  "code": -1,
  "msg": "${errorMessage}",
  "err_code": ${errorCode},
  "result": null
}

返回参数说明:

字段名称 字段类型 是否必须 描述
1 code int 是 状态码，为0时表示接口调用成功，不为0时表示接口调用失败
2 err_code int 是 错误码，当code为0时，返回10000，否则返回对应错误码
3 msg String 是 错误的具体消息
4 result Object 否 返回的结果，当调用失败时为空

备注:

  • 更多返回错误代码请看首页的错误代码描述
 创建时间：2023-08-17 16:48
最后编辑：admin  更新时间：2024-10-18 16:29