# Rest Client组件使用说明
# 组件说明
该组件用于使用 RESTful 服务。REST 是一种无状态客户端-服务器体系结构,在该体系结构中,web服务被视为资源,并可以通过其URL进行标识。 注:该组件不是输入组件,必须要以输入组件打头才能正常使用。
配置名称 | 数据类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
节点名称 | String | 是 | - | 当前创建的节点名称,由用户自定义且不可为空。命名可包含字母、数字、下划线。 |
是否从字段获取URL | Boolean | 是 | false | 指定资源的路径,该路径由传入PDI流中的字段定义。如果选择此选项,则URL可从上级节点的字段名中选择。 |
URL | String | 是 | - | “是否从字段获取URL”为否时,输入指定REST客户端资源的路径。 |
URL字段 | String | 是 | - | “是否从字段获取URL”为是时,从之前组件传入的PDI流中选择该字段。该字段应该包含资源的路径。 |
是否从字段获取HTTP方法 | Boolean | 是 | false | 如果选择此选项,则HTTP方法可从上级节点的字段名中选择。 |
HTTP方法 | String | 是 | GET | 选择当前步骤如何与资源交互。您可以从以下可能的操作中选择:GET:检索资源;POST:创建一个新的资源;PUT:创建或更新现有资源;DELETE:删除资源;HEAD:只检索资源的头部信息;OPTIONS:描述服务器支持的其他方法和操作;PATCH:对资源进行部分更新。 |
HTTP方法字段 | String | 是 | - | 选择定义HTTP方法的字段。此选项仅在选择“是否从字段获取HTTP方法”为“是”时可用。 |
Body字段 | String | 是 | - | 选择定义包含POST、PUT和PATCH方法的请求主体的字段。 |
Content-type | String | 是 | - | 选择资源内容对应的应用类型。 |
结果字段 | String | 是 | result | 返回的结果所指定的输出字段名称,用户可以自己定义名称。 |
HTTP状态码 | String | 是 | - | 返回的HTTP状态码结果所指定的字段名,用户可以自己定义名称。 |
响应时间(ms) | String | 是 | - | 返回的响应时间结果所指定的字段名,用户可以自己定义名称。 |
响应头字段 | String | 是 | - | 返回的响应头结果所指定的字段名,用户可以自己定义名称。 |
账号 | String | 是 | - | 资源访问时使用的用户名。 |
密码 | String | 是 | - | 与HTTP登录用户名关联的密码。 |
优先启用 | String | 是 | - | 选择在服务器给出未经授权的响应之前发送身份验证凭据。 |
代理主机 | String | 是 | - | 如果需要代理身份验证,请指定代理主机的名称。 |
代理端口 | String | 是 | - | 当需要代理认证时,指定代理主机的端口号。 |
选择类型 | String | 是 | - | 证书文件可以从服务所在机器磁盘路径读取,也可以从 HDFS 读取。 |
证书文件 | String | 是 | - | 输入访问需要SSL证书认证的资源的详细信息:指定证书文件的位置。 |
证书文件 | String | 是 | - | 输入访问需要SSL证书的密码。 |
请求头配置 | String | 是 | - | 此表定义现有PDI字段中任何HTTP头的内容。字段名:来自传入PDI流的包含报头信息的字段;输出名:该步骤输出PDI字段的名称。 |
请求参数配置 | String | 是 | - | 定义POST、PUT、DELETE和PATCH请求的参数值。(GET方法的参数应该直接成为URL的一部分。) |