
# Rest Client连接参数说明
连接Rest Client时，相关参数如[表1]所示。
![](https://support.huaweicloud.com/usermanual-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png)
作业运行中禁止修改密码或者更换用户。在作业运行过程中修改密码或者更换用户，密码不会立即生效且作业会运行失败。
 表1Rest Client连接参数 
| 参数名        | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | 取值样例                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|
| 名称         | 连接的名称，根据连接的数据源类型，用户可自定义便于记忆、区分的连接名。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | RestFul API_link                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| 连接地址前缀     | 配置一批接口的前缀，这些接口可能有着公共的认证方式和默认请求头。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | https://test.com/rest/api                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| 测试地址       | 测试连通性地址，自动拼接连接地址前缀。返回200,则视为连接认证成功。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | /test                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| 测试请求方法     | 测试请求方法类型。只支持GET和POST请求。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | GET                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Header参数   | 请求Rest 接口默认使用的header参数，作业时调用接口都会携带此header。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | {"Content-Type":"application/json"}                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| 测试请求body   | "测试请求方法"为POST时显示该参数。 测试请求body，返回200则视为连接认证成功。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | {"Content-Type":"application/json"}                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| 认证类型       | 支持的认证类型。 - NONE：无认证。  - Basic Auth：基础验证。如果数据源API支持用户名和密码的方式进行验证，您可选择此种验证方式，并在选择完成后配置用于验证的用户名和密码，后续数据集成过程中对接数据源时，通过Basic Auth协议传递给RESTful地址。格式：{"Authorization":"Basic base64(username:password)"}。  - Token Auth：Token验证。如果数据源API支持Token的方式进行验证，您可选择此种验证方式，并在选择完成后配置用于验证的固定Token值，后续数据集成过程中对接数据源时，通过传入header中进行验证，格式：{"Authorization":"Bearer "}。  - Oauth 2.0（Authorization Code）：Oauth2.0认证oauth2.0授权码模式，使用账号密码换取accessToken，再使用获取的accessToken访问接口。                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| 用户名        | "认证类型"为Basic Auth时显示该参数。 Rest APi鉴权的用户名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| 密码         | "认证类型"为Basic Auth时显示该参数。 Rest APi鉴权的密码。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Token      | "认证类型"为TOKEN_AUTH时显示该参数。 可通过#token获取该值，放到body\|header中传递。 token为静态token，永不过期，否则token过期会导致作业失败。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| 认证地址       | "认证类型"为OAUTH_CODE_GRANT时显示该参数。 Oauth 2.0模式，该接口支持oauth2.0，使用认证凭据换取令牌，在进行测试连接以及作业前会调用此接口获取令牌，并且在【认证令牌】中定义该令牌在后续接口中携带的位置、名称、和取值方式。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | https://xxx.com/auth/token                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| 认证请求方法     | "认证类型"为OAUTH_CODE_GRANT时显示该参数。 Oauth 2.0模式认证请求方法。当前支持Get、POST。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Get                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| 认证请求Header | "认证类型"为OAUTH_CODE_GRANT时显示该参数。 Oauth 2.0 模式请求header，可以支持通过#authUsername，#authPassword获取认证账号和认证密码。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | {"username": "#authUsername","password": "#authPassword","Content-Type":"application/json"}                                                                                                                                                                                                                                                                                                                                                                              |
| 认证请求Body   | "认证类型"为OAUTH_CODE_GRANT时显示该参数且"认证请求方法"为POST时显示该参数。 Oauth 2.0模式请求body，get请求不支持此参数，支持通过#authUsername，#authPassword获取认证账号和认证密码。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | {"username": "#authUsername","password": "#authPassword"}                                                                                                                                                                                                                                                                                                                                                                                                                |
| 认证账号       | "认证类型"为OAUTH_CODE_GRANT时显示该参数。 Oauth 2.0模式需要填写账号，可以用#authUsername获取此参数，填写到authHeader参数或者authbody参数中。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| 认证密码       | "认证类型"为OAUTH_CODE_GRANT时显示该参数。 Oauth 2.0模式需要填写密码，可以用#authPassword获取此参数，填写到authHeader参数或者authbody参数中。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| 认证令牌       | "认证类型"为OAUTH_CODE_GRANT时显示该参数。 认证令牌，可以从认证接口响应体中获取token，并在测试连接以及作业时携带，仅支持放到header中，此参数定义了参数名称（name）、和参数值（value），参数值支持spel表达式。 认证响应体为：{"code" : 200,"data" : {"access_token" : "DSFSDFWE87WE9089W9EW9ER898WER9W89ER8","expired":1000}}； 如需获取access_token的值，并且满足Bearer 的格式，那么填写格式为：{"NAME":"Authorization","VALUE":"'Bearer ' + #response.data.access_token"} 如需从返回中的header 中获取token, 如:header 对应的key为x-token,则需要配置成VALUE 值设置为#header.x-token。 Authorization 对应的是请求接口的鉴权参数的key。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| 认证令牌有效时间   | "认证类型"为OAUTH_CODE_GRANT时显示该参数。 认证令牌有效时间，单位s，也可以支持EL表达式，0代表永久有效，默认为0。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | - 300，有效时间为300秒。  - #response.data.expired,从认证接口返回的json中获取expired属性的值，支持int类型，默认单位为秒，如果不是这种格式，请手动输入有效时间。   |
| 高级属性       | 高级属性配置，常用配置如下: - 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。   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
