开发数据服务API

更新时间:
复制为 MD 格式

物联网平台数据服务中分析洞察的数据开发任务是使用标准的SQL语句对设备进行数据分析,并将分析结果存储到自定义存储表中。而API服务可将存储表封装成API,方便开发者调用。API服务既可以直接响应设备端请求,也可以用于服务端数据对接。本文介绍自定义数据服务API的具体操作。

创建自定义存储表

添加自定义存储表用来存储SQL数据开发任务的分析结果。本案例存储机房每日的平均温度和平均湿度。

  1. 物联网平台控制台实例概览页面,单击目标企业版实例卡片。

  2. 在左侧导航栏,选择数据服务 > 数据存储

  3. 数据存储页面,单击离线存储页签。

  4. 离线存储页签,单击自定义存储表,添加自定义存储表。

    1. 自定义存储表页签,单击新建自定义存储表

    2. 新建自定义存储表对话框中,完成以下参数设置,其他参数使用默认值。

      参数的详细说明,请参见创建自定义存储表

      参数

      说明

      表显示名

      存储表的名称。本案例输入:raspberrypi4

      表标识符

      存储表的标识符。本案例输入:raspberrypi4

      数据存储时长

      存储表数据保存的时间长度。选择:1个月

      超过所设置的数据,系统将根据表中的时间字段,删除超过存储时长的数据。

    3. 单击确认

  5. 自定义存储表页签下的存储列表中,找到已创建的存储表,单击对应操作列的查看

  6. 单击表结构页签,配置数据表字段。

    本案例添加以下字段,存储机房每日的平均温度和平均湿度。具体操作,请参见管理自定义存储表

    image.png

创建数据开发任务

添加数据开发任务,使用SQL语句查询机房温度、湿度数据并计算每日平均温度、平均湿度。

  1. 物联网平台控制台实例概览页面,单击目标企业版实例卡片。

  2. 在左侧导航栏,选择数据服务 > 分析洞察

  3. 分析洞察页面,单击新建SQL分析

    1. 新建SQL分析对话框,输入数据开发名称(例如Test)和描述信息。

    2. 单击确定

    3. 分析洞察页面,找到新建的SQL分析任务后,单击操作列的开发工作台

  4. 编辑SQL语句,查询产品设备的数据。

    说明

    查询表的名称可以在平台设备表设备数据表菜单下定位到目标产品(例如:树莓派计算机)直接复制。

    SQL编辑器中输入查询语句,例如SELECT * FROM '${pk.产品ProductKey}',单击运行后,下方结果页签展示包含temperature、humidity等字段的设备数据。

  5. 参考以上步骤,创建SQL分析任务(例如:Test),通过日期查询当天的平均温度与湿度数据。

    SQL语句示例如下:SELECT AVG(temperature) AS avg_temperature, AVG(humidity) AS avg_humidity FROM '${pk.产品ProductKey}' WHERE $event_date = '目标日期'。运行后,结果页签显示计算出的平均温度和平均湿度值。

  6. 单击发布执行,将结果存储到自定义存储表,单击校验设置

    image.png

  7. 检验成功后,单击发布任务

    发布成功后,在SQL数据服务工作台不可再编辑SQL语句。

    image.png

生成API

下文以数据开发任务Test为例,生成获取每天平均温度与平均湿度数据的API。

  1. 在物联网平台控制台的左侧导航栏,选择数据服务 > 数据应用

  2. 数据API页签,单击自定义服务API页签,然后单击新建API

  3. 在新建API导航页面,配置API相关参数。

    1. 配置API基本信息,单击下一步

      image.png

    2. 配置请求参数和返回参数。

      image.png

    3. 测试API区域,输入请求参数,单击开始测试

      页面显示测试成功,则API服务运行正常。

      image.png

  4. API配置和测试成功后,单击发布,即可生成一个数据API。

    发布成功后,可直接访问调用API服务。

    自定义API配置和使用的详细内容,请参见自定义服务API

    image.png