文档

添加阿里云API网关数据源

更新时间:

本文档介绍在DataV中添加阿里云API网关数据源的方法,以及相关参数配置说明。阿里云API网关即API托管服务,涵盖API发布、管理、运维、售卖的全生命周期管理。

前提条件

已准备好待添加的阿里云API网关数据源。

添加阿里云API网关数据源操作步骤

  1. 登录DataV控制台

  2. 工作台页面,单击数据准备 > 数据源,进入数据源页面,单击新建数据源

  3. 类型列表中,选择阿里云API网关

  4. 填写API网关信息。

    image

    参数

    说明

    名称

    数据源的显示名称,您可以自由命名。

    域名

    API网关的调用域名。您可以进入API网关控制台查看。

    AppKey

    API网关接口的调用AppKey。请参见创建应用,获取相关接口的AppKey。

    AppSecret

    API 网关接口的调用AppSecret。请参见创建应用,获取相关接口的AppSecret 。

  5. 信息填写完成后,单击确定,完成数据源的添加。

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

使用阿里云API网关数据源操作步骤

  1. 登录DataV控制台

  2. 工作台页面中,将鼠标移动至需要编辑的数据看板上,单击编辑

    重要

    如果您的工作台页面内还没有创建任何数据看板,请参见使用模板创建PC端看板,创建一个数据看板。

  3. 在画布编辑页面,单击画布中的某一组件。

    如果画布中还没有组件,请先添加组件,详情请参见组件画布操作

  4. 在画布右侧的组件配置面板中选择数据源

    image
  5. 设置数据源模块中,选择数据源类型阿里云API网关

  6. 选择已有数据源列表中选择配置完成的阿里云API网关数据源。

  7. 在下方HTTP Method列表中选择一种请求方式,可选择GETPOSTPATCHPUTDELETEHEADOPTIONS这七种请求方式,具体这几种请求方式的解释说明,请参见常用的请求方式

  8. 在下方请求URL编辑框中,填写需要请求的接口URL路径。

  9. 根据您在HTTP Method内选择的不同请求方式,可在下方Header(请求头)Body(请求体)中填写相应的请求函数值。

  10. 单击查看数据返回结果,查看数据返回结果。

使用示例

  1. 获取阿里云API网关接口。

    阿里云API网关是面向用户的产品,您可以通过以下两种方式获取API网关接口。

    • 将您的API托管在API网关,通过DataV调用API网关来调用您的接口,接入方式请参见阿里云API网关官方帮助文档

    • 在阿里云的云市场中,购买相关的API服务,通过DataV调用相关的结果,获取API服务的返回结果,例如IP定位等服务。

  2. 在DataV中配置API数据源,并将结果展示在数据看板中。

    本文以云市场的API服务为例,配置方法如下。

    1. 购买云市场API服务。

      购买云市场API服务

      购买完成后进入API网关管理控制台页面,可以看到该接口的AppKeyAppSecret 信息,将这些信息填写到DataV的数据源处。

      APPKey和APPSecret信息
    2. 获取API服务的域名、路径和参数,在API说明页面查询API定义。

      以其中的IP定位接口为例,可以查看到这个接口的相关信息。

      IP定位接口信息
      • 域名:iploc.market.alicloudapi.com

      • 请求URL:/v3/ip

      • 请求参数:ip

    3. 配置数据源。

      image
    4. 填写查询参数。

      image
    5. 查看查询结果。

      查看查询结果