文档

管理与使用

更新时间:

本文介绍如何管理并使用预置指标API、产品数据API以及自定义服务API。

前提条件

  • 如果需要管理和使用预置指标API,需确保已创建产品和设备,并完成备份。具体操作,请参见数据接入

  • 如果管理和使用产品数据API或自定义服务API,需确保已创建对应API。具体操作,请参见产品数据API自定义服务API

管理API

  1. 物联网平台控制台实例概览页面,单击目标企业版实例ID或备注名称。

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

  3. 数据API页面的API列表,单击预置指标API产品数据API自定义服务API页签,找到要查看的API,然后单击对应API操作列的查看

  4. API详情页面的右上角,选择版本号,查看对应版本的API详情,包括基础信息、API监控和参数。

    • 单击API运维,您可查看API的使用情况。

    • 单击API测试,您可测试API,查看请求详情、返回示例和调用示例。

    API详情页

使用API

根据API的详情信息,您可在自己的服务器集成并调用对应API,获取相关数据,以充分利用数据资产。

重要

单个阿里云账号调用数据服务API的每秒请求数(QPS)最大限制为100。

  • 您可以调用ListAnalyticsData,根据业务需要,获取指定API的数据。

  • 如果您使用阿里云提供的SDK,可根据您的开发语言,参考以下调用示例:

  • 如果您不使用阿里云提供的SDK,开发时则需注意以下公共参数。

    名称

    类型

    是否必传

    示例值

    描述

    apiPath

    String

    pk/temperatureMax

    API路径。

    iotInstanceId

    String

    iot-cn-npk1u******

    实例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\":\"熊大\"}]"

    符合条件的数据详情。

  • 本页导读 (1)
文档反馈