创建API数据源用于实现Dataphin读取API接口传递的数据。本文为您介绍如何创建API数据源。

使用限制

Dataphin仅支持超级管理员和项目管理员角色创建数据源。如何添加成员并授予项目管理员角色,请参见添加项目成员

操作步骤

  1. 请参见入口介绍,进入数仓规划页面。
  2. 按照下图指引,进入新建数据源页面。
    fagag
  3. 新建数据源对话框的半结构化存储区域,选择API
    如果您最近使用过API,也可以在最近使用区域选择API。同时,您也可以在搜索框中,输入API的关键词,快速筛选。API数据源
  4. 新建API数据源对话框中,配置连接数据源参数后,单击确定
    1. 配置数据源的基本信息。
      API基本信息
      参数 描述
      数据源名称 命名规则如下:
      • 只能包含字母、数字或下划线(_)。
      • 长度不能超过64字符。
      数据源描述 对数据源的简单描述。
      数据源配置 选择需要配置的数据源:
      • 如果业务数据源区分生产数据源和开发数据源,则选择生产+开发数据源
      • 如果业务数据源不区分生产数据源和开发数据源,则选择生产数据源
    2. 配置数据源与Dataphin的连接参数。
      当上述步骤中选择了生产+开发数据源,则配置页面如下图所示。如果上述步骤中您选择了生产数据源,则仅展示生产数据源的配置页面。API数据源参数配置
      说明 通常,生产数据源和开发数据源需要配置不同的参数值,但Dataphin也支持配置成相同参数值。
      参数 描述
      URL地址 填写Dataphin访问API的URL地址。
      请求方式 选择API的请求方式,包括POSTGET
      认证方式

      需根据API的认证方式进行选择。

      • Basic Auth
        • 用户名:填写API的用户名。
        • 密码:填写API密码。
      • 阿里云appKey auth
        • AppKey:填写API的AppKey。
        • AppSecret:填写API的AppSecret。
      • None:API无认证。

后续步骤

完成API数据源的创建后,即可将API的业务数据引入至Dataphin。具体操作,请参见配置离线单条管道