本文导读

功能介绍
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ 设备属性/ 修改设备属性

修改设备属性

更新时间：2024-11-26 GMT+08:00

查看PDF

功能介绍

设备的产品模型中定义了物联网平台可向设备下发的属性，应用服务器可调用此接口向指定设备下发属性。平台负责将属性以同步方式发送给设备，并将设备执行属性结果同步返回，如果设备没有响应，平台会返回给应用服务器超时，平台超时时间是20秒。

注意：此接口适用于MQTT设备，暂不支持NB-IoT设备。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v5/iot/{project_id}/devices/{device_id}/properties

表1 路径参数
参数	是否必选	参数类型	描述
device_id	是	String	参数说明：下发属性的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。
project_id	是	String	参数说明：项目ID。获取方法请参见获取项目ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	参数说明：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。
Instance-Id	否	String	参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情。

表3 请求Body参数
参数	是否必选	参数类型	描述
services	否	Object	参数说明：设备执行的属性，Json格式，里面是一个个键值对，如果serviceId不为空，每个键都是profile中属性的参数名（paraName）;如果serviceId为空则由用户自定义属性格式。设属性示例：[{"service_id": "Temperature","properties": {"value": 57}},{"service_id": "Battery","properties": {"level": 80}}]，具体格式需要应用和设备约定, 最大长度为256KB。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
request_id	String	设备属性更新ID，用于唯一标识一条属性更新，在下发更新属性时由物联网平台分配获得。
response	Object	设备上报的属性执行结果。Json格式，具体格式需要应用和设备约定。
error_code	String	属性更新异常错误码。
error_msg	String	属性更新异常错误信息。

请求示例

下发设备属性，服务id为Temperature的属性为value，值为57，服务id为Batter的属性为level，值为80。

PUT https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/properties

{
  "services" : [ {
    "service_id" : "Temperature",
    "properties" : {
      "value" : 57
    }
  }, {
    "service_id" : "Battery",
    "properties" : {
      "level" : 80
    }
  } ]
}

响应示例

状态码： 200

{
  "request_id" : "b1224afb-e9f0-4916-8220-b6bab568e888",
  "response" : {
    "result_code" : 0,
    "result_desc" : "success"
  },
  "error_code" : "string",
  "error_msg" : "string"
}

状态码

状态码	描述
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题： 设备属性

上一篇：设备属性

下一篇：查询设备属性

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消