除了使用系统预置的基础服务API外,您还可以根据业务需要,新建自定义服务API。本文介绍如何创建自定义服务API。

前提条件

已创建数据源相关的指标和存储表,具体信息,请参见指标概述

操作步骤

  1. 登录物联网平台控制台
  2. 实例概览页面,找到对应的数据型实例,单击实例进入实例详情页面。
  3. 在左侧导航栏,选择数据分析 > 数据API
  4. API列表,单击自定义服务API页签,然后单击新建API新建API
  5. 新建API页面,完成API基本信息的配置,然后单击下一步API基本信息
    参数 描述
    API名称 输入API名称。支持中文、英文字母、数字、下划线(_)。长度不超过30个字符。
    API Path 输入API路径。作为API资源标识符,实例下具有唯一性。调用API时,请求参数中apiPath的值与之对应。以正斜线(/)开头,支持英文字母、数字、下划线(_)、正斜线(/),长度不超过128个字符。例如:pk/temperatureMax
    注意 API发布后,API Path不支持修改。
    API标签 输入标签内容后,按回车键,生成标签。

    使用标签功能,为API自定义标识,以便灵活管理API。一个API最多可添加5个标签。

    API描述 输入API的描述,说明API的功能等信息。
    返回类型 调用API后,返回数据的格式,固定为JSON。
  6. 配置参数并测试页面,完成以下配置。
    类别 配置项 说明
    数据源 指标 指标是用于衡量事物发展程度的单位或方法,也常被称作度量。更多信息,请参见什么是指标
    存储表 存储表是通过数据管道或SQL分析任务,输出的自定义存储表。更多信息,请参见数据存储表
    配置参数 数据集 完成数据源配置后,自动显示所选的数据来源。单击预览数据,可跳转至该数据来源的详情页。
    说明 仅选择数据源为指标域时展示该配置项。
    数据范围 选择API的数据范围。
    • 衍生指标:基于原始指标、原始定义、衍生定义,经过求和、计算平均数等汇总计算方式得到的数据。
    • 衍生定义:以原始定义为基础,并应用到子实体上的原始定义指标的衍生。
    衍生指标和定义相关的名词解释,请参见名词解释
    说明 仅选择数据源为指标域时展示该配置项。
    请求参数 单击添加参数,将所选数据来源的指标,添加到API的请求参数。仅支持系统字段及自定义存储表的主键字段。

    添加的参数需包括绑定字段、参数名、参数类型、操作符、必选、示例值、参数描述。

    注意 参数类型为数值型时,操作符不支持LIKE
    返回参数 单击添加参数,将所选数据来源的指标,添加到API的返回参数。

    添加的参数需包括优先级、绑定字段、参数名、参数类型、用于排序、示例值、参数描述。

    说明