Apache NiFi 2.x处理器:InvokeHTTP 2.3.0
包
org.apache.nifi | nifi-standard-nar
描述
这是一个HTTP客户端处理器,可与可配置的HTTP端点进行交互。目标URL和HTTP方法均可配置。当HTTP方法为PUT、POST或PATCH时,FlowFile的内容将作为请求体包含在内,并且FlowFile属性可根据配置属性选择性地转换为HTTP头信息。
标签
客户端,http,https,rest
输入要求
允许
支持敏感动态属性
是
属性
连接超时
等待与HTTP URL建立初始套接字连接的最长时间。
显示名称 | 连接超时 |
描述 | 等待与HTTP URL建立初始套接字连接的最长时间。 |
API名称 | 连接超时 |
默认值 | 5秒 |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
HTTP方法
HTTP请求方法(GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS)。也支持任意方法。除POST、PUT和PATCH之外的方法在发送时不会包含消息体。
显示名称 | HTTP方法 |
描述 | HTTP请求方法(GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS)。也支持任意方法。除POST、PUT和PATCH之外的方法在发送时不会包含消息体。 |
API名称 | HTTP方法 |
默认值 | GET |
表达式语言作用域 | 环境变量和FlowFile属性 |
是否敏感 | 否 |
是否必需 | 是 |
HTTP URL
包含http或https方案的HTTP远程URL,以及带有可选端口和路径元素的主机名或IP地址。URL的任何编码都必须由用户完成。
显示名称 | HTTP URL |
描述 | 包含http或https方案的HTTP远程URL,以及带有可选端口和路径元素的主机名或IP地址。URL的任何编码都必须由用户完成。 |
API名称 | HTTP URL |
表达式语言作用域 | 环境变量和FlowFile属性 |
是否敏感 | 否 |
是否必需 | 是 |
HTTP/2禁用
禁用HTTP/2协议的协商。HTTP/2需要TLS。当禁用HTTP/2时,需要支持HTTP/1.1协议。
显示名称 | HTTP/2禁用 |
描述 | 禁用HTTP/2协议的协商。HTTP/2需要TLS。当禁用HTTP/2时,需要支持HTTP/1.1协议。 |
API名称 | HTTP/2禁用 |
默认值 | False |
允许值 | True |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
代理配置服务
指定用于代理网络请求的代理配置控制器服务。支持的代理:SOCKS、HTTP + 身份验证。在使用SOCKS代理的情况下,无法保证处理器会使用所选的SOCKS版本。
显示名称 | 代理配置服务 |
描述 | 指定用于代理网络请求的代理配置控制器服务。支持的代理:SOCKS、HTTP + 身份验证。在使用SOCKS代理的情况下,无法保证处理器会使用所选的SOCKS版本。 |
API名称 | proxy-configurationservice |
服务接口 | org.apache.nifi.proxy.ProxyConfigurationService |
服务实现 | org.apache.nifi.proxy.StandardProxyConfigurationService |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
请求体启用
为PATCH、POST或PUT方法启用发送HTTP请求体。
显示名称 | 请求体启用 |
描述 | 为PATCH、POST或PUT方法启用发送HTTP请求体。 |
API名称 | 请求体启用 |
默认值 | true |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
依赖项 | HTTP方法设置为[POST、PATCH、PUT]中的任意一个 |
请求分块传输编码启用
启用将Transfer-Encoding头设置为chunked的HTTP请求,并禁用发送Content-Length头。如RFC 7230第3.3.1节所述,分块传输编码适用于HTTP/1.1请求中的消息体。
显示名称 | 请求分块传输编码启用 |
描述 | 启用将Transfer-Encoding头设置为chunked的HTTP请求,并禁用发送Content-Length头。如RFC 7230第3.3.1节所述,分块传输编码适用于HTTP/1.1请求中的消息体。 |
API名称 | 请求分块传输编码启用 |
默认值 | false |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
依赖项 | HTTP方法设置为[POST、PATCH、PUT]中的任意一个 |
请求内容编码
在传输过程中应用于请求体的HTTP内容编码。接收服务器必须支持所选的编码,以避免请求失败。
显示名称 | 请求内容编码 |
描述 | 在传输过程中应用于请求体的HTTP内容编码。接收服务器必须支持所选的编码,以避免请求失败。 |
API名称 | 请求内容编码 |
默认值 | DISABLED |
允许值 | DISABLED |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
依赖项 | HTTP方法设置为[POST、PATCH、PUT]中的任意一个 |
请求内容类型
在为PATCH、POST或PUT方法发送HTTP请求体时应用的HTTP Content-Type头。如果未配置,Content-Type默认为application/octet-stream。
显示名称 | 请求内容类型 |
描述 | 在为PATCH、POST或PUT方法发送HTTP请求体时应用的HTTP Content-Type头。如果未配置,Content-Type默认为application/octet-stream。 |
API名称 | 请求内容类型 |
默认值 | ${mime.type} |
表达式语言作用域 | 环境变量和FlowFile属性 |
是否敏感 | 否 |
是否必需 | 是 |
依赖项 | HTTP方法设置为[POST、PATCH、PUT]中的任意一个 |
请求日期头启用
按照RFC 7231第7.1.1.2节的描述,在HTTP请求中启用发送HTTP日期头。
显示名称 | 请求日期头启用 |
描述 | 按照RFC 7231第7.1.1.2节的描述,在HTTP请求中启用发送HTTP日期头。 |
API名称 | 请求日期头启用 |
默认值 | True |
允许值 | True |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
请求摘要认证启用
按照RFC 7616的描述,在使用用户名和密码凭据的HTTP请求中启用摘要认证。
显示名称 | 请求摘要认证启用 |
描述 | 按照RFC 7616的描述,在使用用户名和密码凭据的HTTP请求中启用摘要认证。 |
API名称 | 请求摘要认证启用 |
默认值 | false |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
依赖项 | 请求用户名设置为任何指定的值 |
请求失败惩罚启用
在收到状态码在400到499之间的HTTP响应时,启用对请求FlowFile的惩罚。
显示名称 | 请求失败惩罚启用 |
描述 | 在收到状态码在400到499之间的HTTP响应时,启用对请求FlowFile的惩罚。 |
API名称 | 请求失败惩罚启用 |
默认值 | false |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
请求头属性模式
定义哪些FlowFile属性作为HTTP头发送到请求中的正则表达式。如果未定义,则不会将任何属性作为头发送。动态属性将始终作为头发送。动态属性名称将作为头键,动态属性值(解释为表达式语言)将作为头值。由于HTTP协议的要求,属性及其值仅限于ASCII字符。
显示名称 | 请求头属性模式 |
描述 | 定义哪些FlowFile属性作为HTTP头发送到请求中的正则表达式。如果未定义,则不会将任何属性作为头发送。动态属性将始终作为头发送。动态属性名称将作为头键,动态属性值(解释为表达式语言)将作为头值。由于HTTP协议的要求,属性及其值仅限于ASCII字符。 |
API名称 | 请求头属性模式 |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
请求多部分表单数据文件名启用
在multipart/form-data HTTP请求中,启用将FlowFile文件名属性作为Content-Disposition头中的filename参数发送。
显示名称 | 请求多部分表单数据文件名启用 |
描述 | 在multipart/form-data HTTP请求中,启用将FlowFile文件名属性作为Content-Disposition头中的filename参数发送。 |
API名称 | 请求多部分表单数据文件名启用 |
默认值 | true |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
依赖项 | 请求多部分表单数据名称设置为任何指定的值 |
请求多部分表单数据名称
启用使用配置的表单名称以multipart/form-data格式发送HTTP请求体。
显示名称 | 请求多部分表单数据名称 |
描述 | 启用使用配置的表单名称以multipart/form-data格式发送HTTP请求体。 |
API名称 | 请求多部分表单数据名称 |
表达式语言作用域 | 环境变量和FlowFile属性 |
是否敏感 | 否 |
是否必需 | 否 |
依赖项 | 请求体启用设置为[true]中的任意一个 |
请求OAuth2访问令牌提供程序
启用使用Authorization头管理检索应用于HTTP请求的OAuth2 Bearer令牌。
显示名称 | 请求OAuth2访问令牌提供程序 |
描述 | 启用使用Authorization头管理检索应用于HTTP请求的OAuth2 Bearer令牌。 |
API名称 | 请求OAuth2访问令牌提供程序 |
服务接口 | org.apache.nifi.oauth2.OAuth2AccessTokenProvider |
服务实现 | org.apache.nifi.oauth2.StandardOauth2AccessTokenProvider |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
请求密码
用于HTTP请求认证的密码。按照RFC 7617的描述,在HTTP基本认证中使用Base64编码。
显示名称 | 请求密码 |
描述 | 用于HTTP请求认证的密码。按照RFC 7617的描述,在HTTP基本认证中使用Base64编码。 |
API名称 | 请求密码 |
表达式语言作用域 | 不支持 |
是否敏感 | 是 |
是否必需 | 否 |
请求User-Agent
应用于请求的HTTP User-Agent头。RFC 7231第5.5.3节描述了推荐的格式。
显示名称 | 请求User-Agent |
描述 | 应用于请求的HTTP User-Agent头。RFC 7231第5.5.3节描述了推荐的格式。 |
API名称 | 请求User-Agent |
表达式语言作用域 | 环境变量和FlowFile属性 |
是否敏感 | 否 |
是否必需 | 否 |
请求用户名
用于HTTP请求认证的用户名。按照RFC 7617的描述,在HTTP基本认证中使用Base64编码。
显示名称 | 请求用户名 |
描述 | 用于HTTP请求认证的用户名。按照RFC 7617的描述,在HTTP基本认证中使用Base64编码。 |
API名称 | 请求用户名 |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
响应体属性名称
用于将HTTP响应体写入传输到Original关系的FlowFile属性的名称。
显示名称 | 响应体属性名称 |
描述 | 用于将HTTP响应体写入传输到Original关系的FlowFile属性的名称。 |
API名称 | 响应体属性名称 |
表达式语言作用域 | 环境变量和FlowFile属性 |
是否敏感 | 否 |
是否必需 | 否 |
响应体属性大小
将HTTP响应体写入FlowFile属性时应用的最大字节数。超过最大值的属性将被截断。
显示名称 | 响应体属性大小 |
描述 | 将HTTP响应体写入FlowFile属性时应用的最大字节数。超过最大值的属性将被截断。 |
API名称 | 响应体属性大小 |
默认值 | 256 |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
依赖项 | 响应体属性名称设置为任何指定的值 |
响应体忽略
禁用将HTTP响应FlowFile写入Response关系。
显示名称 | 响应体忽略 |
描述 | 禁用将HTTP响应FlowFile写入Response关系。 |
API名称 | 响应体忽略 |
默认值 | false |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
响应缓存启用
启用RFC 7234中描述的HTTP响应缓存。缓存响应时会考虑ETag和其他头信息。
显示名称 | 响应缓存启用 |
描述 | 启用RFC 7234中描述的HTTP响应缓存。缓存响应时会考虑ETag和其他头信息。 |
API名称 | 响应缓存启用 |
默认值 | false |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
响应缓存大小
HTTP响应缓存的最大字节数。缓存响应时会考虑ETag和其他头信息。
显示名称 | 响应缓存大小 |
描述 | HTTP响应缓存的最大字节数。缓存响应时会考虑ETag和其他头信息。 |
API名称 | 响应缓存大小 |
默认值 | 10MB |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
依赖项 | 响应缓存启用设置为[true]中的任意一个 |
响应Cookie策略
接受和持久化HTTP Cookie的策略。接受Cookie可在多个请求之间实现持久化。
显示名称 | 响应Cookie策略 |
描述 | 接受和持久化HTTP Cookie的策略。接受Cookie可在多个请求之间实现持久化。 |
API名称 | 响应Cookie策略 |
默认值 | DISABLED |
允许值 | DISABLED |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
响应FlowFile命名策略
确定用于设置传输到Response关系的FlowFile的文件名属性的策略。
显示名称 | 响应FlowFile命名策略 |
描述 | 确定用于设置传输到Response关系的FlowFile的文件名属性的策略。 |
API名称 | 响应FlowFile命名策略 |
默认值 | RANDOM |
允许值 | RANDOM |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 是 |
响应生成必需
启用无论收到何种HTTP响应,都生成并将FlowFile传输到Response关系。
显示名称 | 响应生成必需 |
描述 | 启用无论收到何种HTTP响应,都生成并将FlowFile传输到Response关系。 |
API名称 | 响应生成必需 |
默认值 | false |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
响应头请求属性启用
启用将HTTP响应头作为属性添加到传输到Original、Retry或No Retry关系的FlowFile中。
显示名称 | 响应头请求属性启用 |
描述 | 启用将HTTP响应头作为属性添加到传输到Original、Retry或No Retry关系的FlowFile中。 |
API名称 | 响应头请求属性启用 |
默认值 | false |
允许值 | true |
表达式语言作用域 | 不支持 |
是否敏感 | 否 |
是否必需 | 否 |
响应头请求属性前缀
当HTTP响应头作为属性包含在传输到Original、Retry或No Retry关系的FlowFile中时,作为前缀。建议以分隔符字符(如“.”或“-”)结尾。
显示名称 | 响应头请求属性前缀 |
描述 | 当HTTP响应头作为属性包含在传输到Original、Retry或No Retry关系的FlowFile中时,作为前缀。建议以分隔符字符(如“.”或“-”)结尾。 |
API名称 | 响应头请求属性前缀 |
表达式语言作用域 | 环境变量和FlowFile属性 |
是否敏感 | 否 |
是否必需 | 否 |
依赖项 | 响应头请求属性启用设置为[true]中的任意一个 |