SaveDeviceProp

更新时间:

SaveDeviceProp

调用该接口为指定设备设置标签。

使用说明

  • 单个设备的设备标签总数不超过100个。

  • 单次修改或新增的设备标签数不超过100个。

请求参数

名称

类型

是否必选

示例值

描述

Action

String

SaveDeviceProp

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

Props

String

{"color":"red"}

要设置的设备标签,支持设置多个标签。

设备标签是JSON格式,每个标签的具体结构为:Key:ValueKey是标签名称,Value是对应的标签值。

多个标签使用半角逗号隔开,例如Props={"color":"red","shape":"round"}

ProductKey

String

a1BwAGV****

设备所属的产品ProductKey。

DeviceName

String

light

设备名称。

IotId

String

Q7uOhVRdZRRlDnTLv****00100

设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。

重要

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

返回数据

名称

类型

示例值

描述

Code

String

iot.system.SystemException

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

ErrorMessage

String

系统异常

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

RequestId

String

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

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

Success

Boolean

true

表示是否调用成功。

  • true:调用成功。

  • false:调用失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=SaveDeviceProp&SignatureNonce=54dbd8cf9ffa4e448b87f9283499f290&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Props=%7B%22color%22%3A%22red%22%7D&Timestamp=2024-11-19T08%3A42%3A04Z&ProductKey=k1ymv1DuLfE&DeviceName=myTestDevice&Signature=8Z9ZAjG4BUAq987AilVJRVnWVh0%3D'

正常返回示例

{
    "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
    "Success": true
}