文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ 设备属性/ 修改设备属性 - UpdateProperties
更新时间：2025-12-02 GMT+08:00
查看PDF
分享

修改设备属性 - UpdateProperties

功能介绍

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

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

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    iotda:properties:modify

    Write

    app *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

device_id

是

String

参数说明：下发属性的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。

取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。

project_id

是

String

参数说明：项目ID。获取方法请参见 获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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

OK

{
  "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

错误码

请参见错误码。

父主题： 设备属性