文档

WriteDevicesHotStorageData

更新时间:

调用该接口将设备自定义Topic数据写入时序数据存储。

使用说明

仅标准型和尊享型企业版实例下,支持调用该接口写入时序数据。

时序数据存储详细说明,请参见配置时序数据存储

使用限制

调用该接口的每秒请求写入数据数,由您购买实例下的时序数据存储IOPS规格决定。详细内容,请参见购买企业版实例查看时序数据存储IOPS

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String WriteDevicesHotStorageData

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

IotInstanceId String iot-2w****

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

Items String { "Power": { "value": "on", "time": 1524448722000 }, "WF": { "value": 23.6, "time": 1524448722000 } }

写入的数据,固定为如下JSON数据结构。

{
    "key1": {
        "value":xxx1
        "time":yyy1
    },
    "key2": {
        "value":xxx2
        "time":yyy2
    }
}
  • key1key2为字段标识符,每个Items可包含多个字段。
  • value为字段对应的值,支持数据类型为int32、float、double、text、date、bool、enum、struct和array。详细说明,请参见支持的数据类型
  • time:字段值对应的UTC时间戳,单位为毫秒。
UserTopic String user/a***/b***

自定义Topic。从user类目开始,输入自定义Topic的后续所有类目。

自定义Topic详细说明,请参见自定义Topic

ProductKey String a1BwAGV****

设备所属的产品ProductKey

重要

如果传入该参数,需同时传入DeviceName

DeviceName String device1

设备的名称。

重要

如果传入该参数,需同时传入ProductKey

IotId String y4u2weAI********HMle1234

设备ID。

重要

IotId作为设备唯一标识符,和ProductKeyDeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKeyDeviceName。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。

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

返回数据

名称

类型

示例值

描述

Code String iot.system.SystemException

调用失败时,返回错误码。详细信息,请参见下文错误码

ErrorMessage String 系统异常

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

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

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

Success Boolean true

是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=WriteDevicesHotStorageData
&IotInstanceId=iot-2w****
&Items={ "Power": { "value": "on", "time": 1524448722000 }, "WF": { "value": 23.6, "time": 1524448722000 } }
&UserTopic=user/a***/b***
$ProductKey=a1BwAGV****
$DeviceName=device1
&<公共请求参数>

正常返回示例

XML格式

<WriteDevicesHotStorageDataResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Success>true</Success>
</WriteDevicesHotStorageDataResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Success": true
}
  • 本页导读 (1)
文档反馈