You need to enable JavaScript to run this app.
大数据研发治理套件

大数据研发治理套件

复制全文
REST_API
配置 REST_API 数据源
复制全文
配置 REST_API 数据源

REAT_API 数据源,为您提供离线任务读取 REAT_API 通道的功能,实现与其他数据源之间的数据传输能力。
本文为您介绍 DataSail 的 REAT_API 数据源配置操作。

1 使用限制

  1. 目前 REST_API 数据源仅支持配置批式读取任务。
  2. 子账号新建数据源时,需要有项目的管理员角色,方可以进行新建数据源操作。各角色对应权限说明,详见:管理成员

2 支持的字段类型

类型分类

数据类型

备注

整数类型

LONG

DATETIME 可以转为 LONG 时间戳

字符串类型

STRING

浮点类型

DOUBLE

布尔类型

BOOLEAN

日期时间类型

DATE

DATETIME 需要转为 LONG 时间戳

列表类型

LIST

支持的元素类型:BOOLEAN,LONG,DOUBLE,INTEGER

键值对类型

MAP

键、值支持的类型:LONG,STRING,DOUBLE,BOOLEAN,DATE

3 数据源注册

3.1 数据源配置

新建数据源操作详见配置数据源,下面为您介绍配置 REST_API 数据源信息说明:
其中参数名称前带 * 的为必填参数,名称前未带 * 的为可选填参数。

参数

说明

基本配置

*数据源类型

REST_API

*接入方式

目前仅支持公网方式接入。

*数据源名称

数据源的名称,可自行设置,仅支持中文,英文,数字,“_”,100个字符以内。

描述

对当前新建数据源的注释说明,方便后续进行管理。

参数配置

*API Url

输入源端 API Url 链接地址。

默认请求头

默认的请求头格式,例如:{"Auxxxxxxxion":"Bearer sext-txxxn-1"}

*验证方式:REST_API 数据源注册时,目前支持以下几种验证方式,您可根据实际场景选择鉴权模式。

*No auth

源端 API 没有开启鉴权方式。

  • Token auto refresh auth:您可以在数据源中配置前置请求。任务执行时,系统将先自动执行该前置请求以获取 API Token,供后续鉴权使用。
    *

Basic auth

API 开启了用户名和密码的鉴权方式,需另外填写以下信息:

  • 用户名:输入有数据库权限的账号名称。
  • 密码:输入对应账号的密码信息。

Token auth

API 开启了 Token 的鉴权方式,您需要输入具体的 Token 信息:

  • Token:输入可以验证通过的 Token 值信息。

Token auto refresh auth

您可以在数据源中配置前置请求。任务执行时,系统将先自动执行该前置请求以获取 API Token,供后续鉴权使用。
使用此鉴权方式,您还需填写以下预请求信息:

  • 预请求 URL:填写您需要预请求的 URL,格式可参考 http://180.184.80.202:28000/test/search_test
  • 预请求 Method:请求方法支持 GET 和 POST,两种方式。
  • 预请求参数:输入传递给 API 的请求参数信息,格式示例如下:
    • GET方法:abc=123&def=456
    • POST方法:{"abc":123,"def":456}
  • 预请求 Header:输入发起预请求时所需的 Header 信息,格式可参考:{"Content-Type":"application/json"}
  • 预请求 Body:输入预请求时所需的 Body 信息,格式可参考:{"client_id":"","client_secret":""}
  • 参数 Key:填写前置请求返回内容引用至正式请求中的参数名称,如 pagenum,在正式请求时,可通过 {{pagenum}} 方式进行引用。
  • response 路径:输入数据存储的 json path 路径,将会读取您输入 path 路径下的 json 内容。对 json 进行操作,$表示根节点,.号表示取子节点,如 $.data.page 表示取根节点下的 data 子节点下的 page 内容。
  • 预览数据:上述参数配置完成后,可单击自动获取按钮,便可自动获取并预览展示 API 中的数据,检查数据格式情况;您也可手动进行数据输入。

3.2 测试连通性

参数项填写完整后,勾选已绑定的独享集成资源组,并单击上方测试按钮,执行测试连通性。同时,您可展开资源组 ID,查看该资源组所属 VPC 下各子网的网络连通情况,您需确保各子网均能与数据源连通,避免因子网连通问题导致任务执行异常。

说明

连通性测试成功后,单击确定按钮,在弹窗中完成可用资源组的选择后,便可完成新增。

4 后续步骤

数据源创建完成后,您可以进行后续的 REST_API 集成任务配置,详见:配置 REST_API 任务

最近更新时间:2026.01.16 11:57:19
这个页面对您有帮助吗?
有用
有用
无用
无用