本文介绍如何管理并使用基础服务API以及自定义服务API。
前提条件
操作步骤
- 登录物联网平台控制台。
- 在实例概览页面,找到对应的数据型实例,单击实例进入实例详情页面。
- 在左侧导航栏,选择数据分析 > 数据API。
- 在数据API页面的API列表,单击基础服务API或自定义服务API页签,找到要查看的API,再单击对应API操作列的查看。
- 在API详情页的右上角,选择版本号,查看对应版本的API详情。
- 在API运维页签,您可查看API的使用情况。
- 单击API测试,您可测试API。
- 根据API的详情信息,您可在自己的服务器集成并调用对应API,获取相关数据,以充分利用数据资产。
注意 单个阿里云账号调用数据分析API的每秒请求数(QPS)最大限制为5。
- 您可以调用ListAnalyticsData,根据业务需要,获取指定API的数据。
- 如果您使用阿里云提供的SDK,可根据您的开发语言,参考以下调用示例:
- 如果您不使用阿里云提供的SDK,开发时则需注意以下公共参数。
名称 类型 是否必传 示例值 描述 apiPath String 是 pk/temperatureMax API路径。 iotInstanceId String 是 iot-cn-npk1u****** 实例ID。更多信息,请参见如何获取实例ID?。 pageNum Integer 开启分页时必传 10 分页的页码。 pageSize Integer 开启分页时必传 100 每页显示结果的条数,最大值为100。 - 在API详情页,您可以查看API的返回参数。以下是API的公共返回参数。
名称 类型 示例值 描述 Count Long 3 符合查询条件的记录总条数。 HasNext Boolean false 符合条件的数据是否有下一页。 - true:是
- false:否
PageNum Integer 1 分页的页码。 PageSize Integer 100 每页显示结果的最大条数。 ResultJson String [{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"王五\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"李四\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"熊大\"}]" 符合条件的数据详情。