数据服务为物联网数据服务平台中用户自定义生成的API和基础API,提供管理能力。通过数据管理,可查看API的各类详细数据。本章将详细介绍数据服务及其使用方法。

前提条件

已自定义生成API并成功发布。详细内容请参见生成一个数据API

操作步骤

  1. 登录数据分析控制台
  2. 在上方导航栏中选择数据资产,单击数据服务
    数据服务入口
  3. 数据服务页面中查看已有API的信息。
    数据服务列表
    表 1. 参数说明
    参数 描述
    ID 生成API并发布成功后,由系统自动生成的API ID。
    名称 生成API时设置的API名称。单击名称可查看该API的详细信息。
    类型 API的接口类型,目前有两种类型。
    • 自定义API:用户自定义生成的API。详细内容请参见生成一个数据API
    • 基础服务API:由系统提供的,用于做基础服务调用的API。
    调用量 该API被调用的次数。
    创建时间 该API发布成功的时间。
    操作 单击查看,可查看详细的API信息。

    数据服务页面,您可以通过筛选接口类型或搜索API名称,筛选出数据服务列表中显示的API。

  4. 单击API名称或者对应操作栏中的查看,进入数据详情页面查看API详情。
    数据服务详情页
    表 2. 参数说明
    参数 描述
    ApiSrn API资源定位符,单击复制调用地址,可直接使用ApiSrn调用该API。详细的调用API操作请参见JAVA SDK调用示例Python SDK调用示例
    基础信息 API的基础信息。
    • ID:生成API并发布成功后,由系统自动生成的API ID。
    • 接口类型:目前有用户自定义生成的自定义API基础服务API两种类型。
    • 创建时间:该API发布成功的时间。
    HTTP接口信息 API的HTTP接口信息。
    • ApiSrn:API资源定位符。
    • 请求方式:API的HTTP请求方式,目前仅支持POST方法。
    • 返回类型:调用API后返回消息的数据类型。
    请求参数 该API的请求参数列表。
    返回参数 该API的返回参数列表。
    正常返回示例 调用API成功后返回的消息示例。
    异常返回示例 调用API失败后返回的消息示例。可根据错误码定义中的错误信息,处理问题。
    错误码定义 已定义的错误码和详细的错误信息描述。
  5. 单击测试服务,可针对自定义生成的API进行测试。
    测试数据服务页面,输入请求参数,单击开始测试测试数据服务