QueryDevicesHotStorageData_物联网平台_API文档-阿里云OpenAPI开发者门户

接口说明

使用说明

仅标准型和尊享型企业版实例下，支持调用该接口查询热数据。

热数据存储详细说明，请参见配置热数据存储。

使用限制

调用该接口的每秒请求写入数据数，由您购买实例下的热数据存储 IOPS规格决定。详细内容，请参见购买企业版实例和查看热数据存储 IOPS。
仅可查询存储时效内的数据。数据存储时效，请参见存储配置。

说明数据存储时间从存储字段的时间戳表示的时间当日开始计算。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

iot:QueryDevicesHotStorageData	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
IotInstanceIdstring	实例 ID。您可在物联网平台控制台的实例概览页面，查看当前实例的 ID。示例值:iot-2w****
PageSizeinteger<int32>	单个字段标识符可返回的数据记录数量，最大值为 100。展开详情示例值:10取值 <= 201
ProductKeystring	设备所属的产品 ProductKey。展开详情示例值:a1BwAGV****参考取值来源: CreateProduct QueryProductList ReleaseProduct ListProductByTags BindLicenseProduct BatchBindProductsIntoProject
DeviceNamestring	设备的名称。展开详情示例值:device1
NextPageTokenstring	下一页标识。如果存在下一页，服务会返回此 token，下次请求带上即可。示例值:Bo***x44Qx
StartTimeinteger<int64>	要查询的数据记录的开始时间，必须小于结束时间 EndTime。取值为毫秒值时间戳，例如：1579249499000。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1579249499000取值 <= 999999999999999
Identifierstring	已存储热数据中的字段标识符。即调用 WriteDevicesHotStorageData 接口写入热数据中请求参数 Items 中的字段标识符。示例值:temperature
Ascinteger<int32>	返回结果中数据记录的排序方式，取值：展开详情示例值:0取值 <= 5
IotIdstring	设备 ID。展开详情示例值:y4u2weAI********HMle1234
EndTimeinteger<int64>	要查询的数据记录的结束时间，必须大于起始时间 StartTime。取值为毫秒值时间戳，例如：1579249499000。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1579249499000取值 <= 999999999999999
UserTopicstring	要查询数据所属自定义 Topic。从`user`类目开始，输入自定义 Topic 的后续所有类目。展开详情示例值:user/a*/b*

请求说明

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

返回参数

字段名称	字段详情
Codestring	调用失败时，返回错误码。详细信息，请参见下文错误码。示例值:iot.system.SystemException
ErrorMessagestring	调用失败时，返回的出错信息。示例值:系统异常
RequestIdstring	阿里云为该请求生成的唯一标识符。示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean	是否调用成功。展开详情示例值:true
Dataobject	调用成功后，返回的数据。

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	iot.device.InvalidTimeBucket	The specified time range is invalid.	诊断
400	iot.device.NullDeviceName	The DeviceName parameter cannot be empty.	诊断
400	iot.prod.NullProductKey	The ProductKey parameter cannot be empty.	诊断
400	iot.common.InvalidPageParams	The specified pagination size or pagination parameter is invalid.	诊断
400	iot.prod.NotExistedProduct	The specified product does not exist.	诊断
400	iot.device.PageTokenIsIllegal	The paging token is invalid.	诊断
400	Iot.Device.NotExistedDevice	The device does not exist.	诊断
400	iot.device.InvalidFormattedDeviceName	The DeviceName format is invalid.	诊断
400	iot.prod.InvalidFormattedProductkey	The ProductKey format is invalid.	诊断
400	iot.system.IllegalRequest	The request parameter is invalid.	诊断
400	iot.device.InvalidIoTId	The specified device ID is invalid.	诊断
400	iot.storage.HotStorageIopsReadNotEnough	The timeline storage read IOPS is not enough.	诊断

变更历史

暂无变更历史