产品数据API包括产品下设备的快照数据API、原始数据API和事件数据API,您可以新建指定的产品数据API后,调用对应API获取产品下指定设备的原始数据、快照数据或事件数据。本文介绍如何新建和编辑产品数据API。
前提条件
新建产品数据API
产品数据API只能查询近30天的数据。
在物联网平台控制台的实例概览页面,单击目标企业版实例ID或备注名称。
在左侧导航栏,选择数据服务 > 数据API。
单击产品数据API页签,然后单击新建API。
在新建API面板,选中目标产品前的复选框。
单击应用。
产品数据API列表,会新增对应产品的快照数据和原始数据的API。
参数
快照数据API
原始数据API
事件数据API
API名称
${productName}产品快照数据查询
${productName}产品原始数据查询
${productName}产品事件数据查询
API Path
/${productKey}/snapshot/data/get
/${productKey}/rawdata/get
/${productKey}/event/data/get
其中
${productName}
为产品名称,${productKey}
为产品的唯一标识。
编辑产品数据API
对于产品快照数据查询API和产品原始数据查询API,支持编辑API名称、入参和出参。
在数据API页面,单击产品数据API页签。
在API列表,找到目标产品的快照数据查询API或原始数据查询API,单击右侧操作列的编辑。
在编辑API配置向导页面,修改API基本信息,然后单击下一步。
参数
描述
API名称
修改API名称。支持中文、英文字母、数字、下划线(_)和短划线(-)。长度不超过30个字符。
API Path
不支持修改。
API标签
输入标签内容后,按回车键,生成标签。
支持中文、英文字母、数字、下划线(_)和短划线(-)。长度不超过30个字符。
使用标签功能,为API自定义标识,以便灵活管理API。
重要一个API最多可添加5个标签。
API描述
输入API的描述,说明API的功能等信息。
返回类型
调用API后,返回数据的格式,固定为JSON。
在配置参数并测试页面,修改以下配置参数和高级设置。
类别
配置项
说明
配置参数
请求参数
单击添加参数,选择可添加的绑定字段。
添加的参数支持设置操作符、是否必填、示例值和参数描述。
单击删除图标,删除对应参数。
重要参数类型为数值型时,操作符不支持
LIKE
。返回参数
默认已选择该API可返回的全部字段。可设置是否用于排序、示例值和参数描述。
您可单击删除图标,删除对应参数。删除参数后,可单击添加参数,重新添加绑定字段为返回参数,也可选中页面右侧的选择全部参数复选框,重新选择所有字段作为API返回参数。
说明用于排序是指对查询获取的数据根据该字段的值进行排序(升序或降序),排序后再返回查询结果。
排序方式
选择参数的排列顺序。
升序(默认):参数以升序排列。
降序:参数以降序排列。
高级设置
开启返回结果分页
选择是否开启返回结果分页。
不开启:仅可查看100条以内的返回结果。
开启:可分页查看所有返回结果。开启后,自动增加以下公共参数:
pageNum:分页的页码。
pageSize:每页显示结果的条数,最大值为100。
超时报错设置
调用API的请求超过8000毫秒时,返回超时报错。不支持修改该参数。
完成上述配置后,在测试API区域内,输入请求参数的测试值后,单击开始测试。
您可在返回示例页签查看返回的示例数据,也可单击请求详情查看发起请求后的具体信息。
单击发布。
重要发布API前,需确保该API已通过测试。
仅单击保存的API,API详情页面显示状态为未上线。
API发布成功,才能被正常调用查询数据。
后续操作
您可以调用产品数据API查看产品下指定设备的原始数据、快照数据和事件数据。
调用示例,请参见:
您可以在API详情页面,查看API的使用情况。具体操作,请参见查看API。