创建API数据源

权限说明

仅支持拥有新建数据源权限点的自定义全局角色和超级管理员、数据源管理员、板块架构师、项目管理员系统角色创建数据源。

操作步骤

1. 在Dataphin首页，单击顶部菜单栏管理中心 > 数据源管理。

2. 在数据源页面，单击+新建数据源。

3. 在新建数据源对话框的半结构化存储区域，选择API。

   如果您最近使用过API，也可以在最近使用区域选择API。同时，您也可以在搜索框中，输入API的关键词，快速筛选。

4. 在新建API数据源对话框中，配置相关连接数据源参数。

   1. 配置数据源的基本信息。

      参数	描述
      数据源名称	命名规则如下： 只能包含中文、英文字母大小写、数字、下划线（_）或短划线（-）。 长度不能超过64字符。
      数据源编码	配置数据源编码后，您可以在Flink_SQL任务中通过数据源编码.表名称或数据源编码.schema.表名称的格式引用数据源中的表；如果需要根据所处环境自动访问对应环境的数据源，请通过${数据源编码}.table或${数据源编码}.schema.table的变量格式访问。更多信息，请参见Dataphin数据源表开发方式。 重要 目前仅支持MySQL、Hologres、MaxCompute数据源。 数据源编码配置成功后不支持修改。
      数据源描述	对数据源的简单描述。不超过128字符。
      数据源配置	选择需要配置的数据源： 如果业务数据源区分生产数据源和开发数据源，则选择生产+开发数据源。 如果业务数据源不区分生产数据源和开发数据源，则选择生产数据源。
      标签	您可根据标签给数据源进行分类打标，如何创建标签，请参见数据源管理标签。

   2. 配置数据源与Dataphin的连接参数。

      

      说明

      通常情况下，生产数据源和开发数据源需配置为非同一个数据源，以实现开发数据源与生产数据源的环境隔离，降低开发数据源对生产数据源的影响。但Dataphin也支持配置成同一个数据源，即相同参数值。

      参数	描述
      URL地址	请填写API请求的URL地址。
      认证方式	请根据API的认证方式进行选择。 Basic Auth 用户名：填写API的用户名。 密码：填写API密码。 阿里云appKey auth AppKey：填写API的AppKey。 AppSecret：填写API的AppSecret。 None：API无认证。 API Key Key：填写API Key认证方式的键。 Value：填写API Key认证方式的值。 添加至：将API Key添加至API请求体参数Parameters、Headers、Body中的其中一个。 Bearer Token：填写Token令牌信息。该信息将添加至API的headers中进行请求。

5. 单击确定，完成API数据源的创建。