本文档为您介绍在DataV中添加Open API数据源的方法及参数配置说明。

Open API是阿里云提供的云产品开放接口的调用方式，使用Open API可以方便地调用各云产品提供的API接口，轻松实现控制及查询等功能。在DataV中，最常见的场景是使用Open API调用其他的云产品的API，获取数据并展示出来。

操作步骤

  1. 登录DataV控制台。
  2. 选择我的数据 > 添加数据。
  3. 单击类型下拉菜单，选择Open API。
  4. 填写Open API相关信息。
    添加Open API数据源
    参数 说明
    名称 数据源的显示名称，您可以自由命名。
    EndPoint Open API的服务地址，需要您从云产品的API文档处获取。比如ECS的为ecs.aliyuncs.com，云监控的杭州region的服务地址为metrics.cn-hangzhou.aliyuncs.com。
    APIVersion 云产品的API版本，您可以从云产品的API文档获取，如云监控的API版本为2017-03-01。
    AppKey 可以调用Open API的账号的AccessKey ID。
    AppSecret 可以调用Open API的账号的AccessKey Secret。
  5. 信息填写完成后，单击确定，完成数据源的添加。

    新添加的数据源会自动显示在数据源列表中。

使用Open API数据源

  1. 在DataV控制台上，单击我的可视化，选择您的项目，单击编辑，进入大屏编辑界面。
  2. 单击选择某一组件，在右侧的数据面板中，单击配置数据源。
  3. 在设置数据源页面中，选择数据源类型为Open API；选择已有数据源为您已经配置完成的Open API数据源。
  4. 填写接口名称。

    在编辑框中填写需要调用的接口名称，即API调用中的Action参数。取值来自云产品提供的API列表，比如云监控的QueryMetricList。

  5. 填写返回结果路径。

    取Open API返回结果的一部分作为返回结果路径。

    比如Open API返回： 
    {
         "data": [
           {
             "x": 1,
             "y": 2
           },
           {
             "x": 2,
             "y": 4
           }
          ]
      }
    如果返回结果路径中填写data，则数据响应结果为： 
    [
           {
             "x": 1,
             "y": 2
           },
           {
             "x": 2,
             "y": 4
           }
        ]
    说明 这个转换可以在过滤器中进行，此处可以留空不填。
  6. 在下方的编辑框中输入查询参数。
    • 查询参数为Open API的接口参数，以JSON对象的形式填写。
    • 参数名参考云产品API的入参说明。
    • 回调id在JSON对象的value中填写。
    以云监控的QueryMetricList API为例，查询参数如下所示。 
    // 使用回调 id: myInstanceId
            {
              "Period": 600,
              "StartTime": "2018-11-20 11:30:00",
              "EndTime": "2018-11-21 11:30:00",
              "Metric": "cpu_idle",
              "Project": "acs_ecs_dashboard",
              "Dimensions": "{instanceId:':myInstanceId'}"
            }
  7. 单击预览数据源返回结果，查看数据响应结果。

    数据响应成功后即可在大屏中查看对应组件的数据展示效果。