更新时间:2024-09-12 GMT+08:00
分享

Rest Client数据连接参数说明

表1 Rest Client连接

参数

是否必选

说明

数据连接类型

Rest Client连接固定选择为Rest Client。

数据连接名称

数据连接的名称,只能包含字母、数字、下划线和中划线,且长度不超过100个字符。

标签

标识数据连接的属性。设置标签后,便于统一管理。
说明:

标签的名称,只能包含中文、英文字母、数字和下划线,不能以下划线开头,且长度不能超过100个字符。

适用组件

选择此连接适用的组件。勾选组件后,才能在相应组件内使用本连接。

说明:
  • 当开启数据集成作业特性后,可勾选数据集成组件,勾选后在数据开发组件创建集成作业时支持选择本数据连接。
  • 离线处理集成作业功能当前需申请白名单后才能使用。如需使用该特性,请联系客服或技术支持人员

基础与网络连通配置

连接地址前缀

适用组件勾选数据集成时显示该参数。

连接地址前缀,测试以及作业时调用接口,会自动拼接此前缀。https仅支持TLSv1.2协议。

例如: https://xxx.com/prefix。

默认Header参数

适用组件勾选数据集成时显示该参数。

默认header参数,作业时调用接口都会携带此header。例如:{"Content-Type":"application/json"}

KMS密钥

通过KMS加解密数据源认证信息,选择KMS中已创建的密钥。

绑定Agent

适用组件勾选数据集成时显示该参数。

DataArts无法直接与非全托管服务进行连接,需要提供DataArts Studio与非全托管服务通信的代理。CDM集群可以提供通信代理服务,请选择一个CDM集群,如果没有可用的CDM集群,请先通过数据集成增量包进行创建。

数据集成配置

测试地址

测试连通性地址,返回200则视为连接认证成功。

例如:/test

测试请求方法

测试请求方法,GET/POST。

例如:GET

高级属性

高级属性配置,常用配置如下:

  • maxTotal:连接池最大值,默认200。
  • connectTimeout:连接超时时间,默认10000ms。
  • connectionRequestTimeout:连接池获取连接超时时间,默认5000ms。
  • socketTimeout:超时时间,默认60000ms。
  • maxRetryCount:最大重试次数,默认30次。
  • maxRetryTime:最大重试时间,默认10分钟。
  • httpCodeSuccess: http响应成功码,默认值为:200,201,202。
  • httpCodeNotNeedRetry: http响应码,不需要进行重试的错误码,默认值为:200,201,202,401,403,404。

数据源认证及其他功能配置

认证方式

认证方法。包括:

  • NONE:无认证。
  • BASIC_AUTH:基础验证。

    如果数据源API支持用户名和密码的方式进行验证,您可选择此种验证方式,并在选择完成后配置用于验证的用户名和密码,后续数据集成过程中对接数据源时,通过Basic Auth协议传递给RESTful地址,完成验证。格式:{"Authorization":"Basic base64(username:password)"}

  • TOKEN_AUTH:Token验证(token为静态token,永不过期,否则token过期会导致作业失败)。

    如果数据源API支持Token的方式进行验证,您可选择此种验证方式,并在选择完成后配置用于验证的固定Token值,后续数据集成过程中对接数据源时,通过传入header中进行验证,格式:{"Authorization":"Bearer <token>"}。

  • OAUTH_CODE_GRANT Oauth 2.0(Authorization Code):Oauth2.0认证。

    Oauth2.0授权码模式,使用账号密码换取accessToken,再使用获取的accessToken访问接口。

用户名

认证方式为BASIC_AUTH模式时显示该参数。

可以通过#username获取该值,放到body、header中传递。

密码

认证方式为BASIC_AUTH模式时显示该参数。

可以通过#password获取该值,放到body、header中传递。

Token

认证方式为TOKEN_AUTH模式时显示该参数。

可以通过#token获取该值,放到body、header中传递。

认证地址

认证方式为OAUTH_CODE_GRANT模式时显示该参数。

Oauth 2.0模式认证地址,该接口支持Oauth2.0,使用认证凭据换取令牌,在进行测试连接以及作业前会调用此接口获取令牌,并且在【认证令牌】中定义该令牌在后续接口中携带的位置、名称、和取值方式。

例如: https://xxx.com/auth/token

认证请求方法

认证方式为OAUTH_CODE_GRANT模式时显示该参数。

Oauth 2.0模式认证请求方法,GET/POST。在填写了认证地址的情况下,必填。

例如:GET

认证账号

认证方式为OAUTH_CODE_GRANT模式时显示该参数。

Oauth 2.0模式需要填写账号,可以用#authUsername获取此参数,填写到authHeader参数或者authbody参数中。

认证密码

认证方式为OAUTH_CODE_GRANT模式时显示该参数。

Oauth 2.0模式需要填写密码,可以用#authPassword获取此参数,填写到authHeader参数或者authbody参数中

认证请求header

认证方式为OAUTH_CODE_GRANT模式时显示该参数。

Oauth 2.0模式请求header,支持通过#authUsername、#authPassword获取认证账号和认证密码。

例如:{"username": "#authUsername","password": "#authPassword","Content-Type":"application/json"}

认证请求body

认证方式为OAUTH_CODE_GRANT模式时显示该参数。

Oauth 2.0模式请求body,get请求不支持此参数,可以支持通过#authUsername、#authPassword获取认证账号和认证密码。

例如:{"username": "#authUsername","password": "#authPassword"}

认证令牌

认证方式为OAUTH_CODE_GRANT模式时显示该参数。

认证令牌,可以从认证接口响应体中获取token,并在测试连接以及作业时携带,仅支持放到header中。此参数定义了参数名称(name)、参数值(value),参数值支持spel表达式。

例如:

认证响应体为:

{

"code" : 200,

"data" : {

"access_token" : "DSFSDFWE87WE9089W9EW9ER898WER9W89ER8",

"expired":1000

}

}

如果我们要获取access_token的值,并且满足Bearer <token>的格式,则填写格式为:

NAME: Authenrization

VALUE:'Bearer ' + #response.data.access_token

认证令牌有效时间

认证方式为OAUTH_CODE_GRANT模式时显示该参数。

认证令牌有效时间,单位s,支持el表达式,0代表永久有效,默认为0。

例1:300,有效时间为300秒。

例2:#response.data.expired,从认证接口返回的json中获取expired属性的值,支持int类型,默认单位为秒,如果不是此格式,请手动输入有效时间。

相关文档