调用该接口批量设置设备属性值。

使用说明

物模型功能定义数据类型为float或double时,对应参数值(即使值为整数)至少携带一位小数位。例如10.0、11.1。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SetDevicesProperty

系统规定参数。取值:SetDevicesProperty。

DeviceName.N RepeatList light

要设置属性值的设备名称列表。设备名称的个数范围为1~100个。

Items String {"Switch":1,"Color":"blue"}

要设置的属性信息,数据格式为JSON。

每个属性信息由标识符与属性值(key:value)构成,多个属性用英文逗号隔开。

例如,设置智能灯的两个属性:

  • 标识符为Switch的开关属性,数据类型为Bool,设置值为1(开)。
  • 标识符为Color的灯颜色属性,数据类型为String,设置值为blue

那么要设置的属性信息,JSON格式如下:

Items={"Switch":1,"Color":"blue"}
说明 如果设置自定义模块testFb(非默认模块)的属性,则格式为:Items={"testFb:Switch":1,"testFb:Color":"blue"}
ProductKey String a1BwAGV****

要设置属性值的设备所属的产品ProductKey

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

重要
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无实例概览页面或ID值,则无需传入。

实例的更多信息,请参见实例概述

Qos Integer 1

指定调用本接口时,消息的发送方式。取值:

  • 0(默认):最多发送一次。
  • 1:最少发送一次。如果QoS=1消息未接收到PUBACK消息,会在设备重连时,重新推送给设备。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

ErrorMessage String 系统异常

调用失败时,返回的出错信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDevicesProperty
&DeviceName.1=1102andriod02
&DeviceName.2=1102android01
&Items=%7B%20%20%20%20%20%22Data%22%3A%221372060916%22%2C%20%20%20%20%20%22Status%22%3A1%20%7D
&ProductKey=a1hWjHD****
&<公共请求参数>

正常返回示例

XML格式

<SetDevicesPropertyResponse>
  <RequestId>2E19BDAF-0FD0-4608-9F41-82D230CFEE38</RequestId>
  <Success>true</Success>
</SetDevicesPropertyResponse>

JSON格式

{
  "RequestId": "2E19BDAF-0FD0-4608-9F41-82D230CFEE38",
  "Success": true
}

错误码

访问错误中心查看更多错误码。