简要描述:

  • 通过调用该接口进行清除设备物模型属性期望值

接口版本:

版本号 制定人 制定日期 修订日期
1.0 张浩 2023-06-12

请求URL:

iot-platform/device-thing-model-server/v1/property/desired/delete

请求方式:

  • POST

请求头:

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

返回示例:

{
    "productId":"AAcmXyLkS1",
    "deviceId":"339a0519f96b432092d6c3451b2dd53e",
    "properties": {
        "default":[
             "power",
              "color"
        ]
    }
}

请求参数:

参数名 是否必须 类型 说明
productId string 产品ID
deviceId string 设备ID
messageId String 消息ID,最长为64位字符,标识该消息的唯一ID,如不传则由服务端随机生成
properties Object 属性对象
properties.{module} List(string) 属性标识符列表,如没有该属性期望值,则忽略

返回示例:

正确时返回:

{
  "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 返回的结果,当调用失败时为空

result返回值描述:

字段名称 字段类型 是否必须 描述
1 messageId String 下发设备的行为调用消息ID,当为异步调用时不为空
2 resultData Object 行为触发结果,当为同步调用时不为空

备注:

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