跳到主要内容
版本:Next

Enterprise WeChat

Enterprise WeChat 接收器连接器

描述

一个将 SeaTunnel 行数据发送到企业微信机器人 webhook 的接收插件。作业配置中的连接器标识符是 WeChat

例如,如果来自上游的数据是 ["alarmStatus": "firing", "alarmTime": "2022-08-03 01:38:49","alarmContent": "The disk usage exceeds the threshold"], 微信机器人的输出内容如下:

alarmStatus: firing 
alarmTime: 2022-08-03 01:38:49
alarmContent: The disk usage exceeds the threshold

提示:WeChat 接收器发送文本消息。每一行数据会先格式化为 字段名: 字段值 的多行文本,再发送到 webhook。

关键特性

选项

名称类型必需默认值描述
urlString-企业微信机器人 webhook URL。
mentioned_listarray-需要提醒的用户 ID 列表,使用 @all 提醒所有人。
mentioned_mobile_listarray-需要提醒的手机号列表,使用 @all 提醒所有人。
retryint-HTTP 请求抛出 IOException 时的最大重试次数。
retry_backoff_multiplier_msint100重试退避倍数,单位毫秒。
retry_backoff_max_msint10000最大重试退避时间,单位毫秒。
multi_table_sink_replicaint-多表写入时使用的 sink 副本数。
common-options-接收器插件通用参数。

url [string]

企业微信 webhook URL 格式为 https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXXXXX

mentioned_list [array]

需要提醒的用户 ID 列表,使用 @all 提醒所有人。如果无法获取用户 ID,可以使用 mentioned_mobile_list

mentioned_mobile_list [array]

需要提醒的手机号列表,使用 @all 提醒所有人。

common options

接收器插件常用参数,详见 Sink Common Options

示例

简单的例子:

WeChat {
url = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693axxx6-7aoc-4bc4-97a0-0ec2sifa5aaa"
}
WeChat {
url = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693axxx6-7aoc-4bc4-97a0-0ec2sifa5aaa"
mentioned_list = ["wangqing", "@all"]
mentioned_mobile_list = ["13800001111", "@all"]
}

变更日志

Change Log
ChangeCommitVersion
[improve] http connector options (#8969)https://github.com/apache/seatunnel/commit/63ff9f910a2.3.10
[Feature][Restapi] Allow metrics information to be associated to logical plan nodes (#7786)https://github.com/apache/seatunnel/commit/6b7c53d03c2.3.9
[Feature][Core] Support using upstream table placeholders in sink options and auto replacement (#7131)https://github.com/apache/seatunnel/commit/c4ca74122c2.3.6
[Feature][Connector-V2] Support TableSourceFactory/TableSinkFactory on http (#5816)https://github.com/apache/seatunnel/commit/6f49ec6ead2.3.4
[Improve][build] Give the maven module a human readable name (#4114)https://github.com/apache/seatunnel/commit/d7cd6010512.3.1
[Improve][Project] Code format with spotless plugin. (#4101)https://github.com/apache/seatunnel/commit/a2ab1665612.3.1
[Hotfix][OptionRule] Fix option rule about all connectors (#3592)https://github.com/apache/seatunnel/commit/226dc6a1192.3.0
[Feature][Connector-V2][Http] Add option rules && Improve Myhours sink connector (#3351)https://github.com/apache/seatunnel/commit/cc8bb60c832.3.0
[Bug][Connector-V2] Fix wechat sink data serialization (#2856)https://github.com/apache/seatunnel/commit/3aee11fc162.3.0-beta
[Feature][Connector-V2] Add Enterprise Wechat sink connector (#2412)https://github.com/apache/seatunnel/commit/3e200e0a382.2.0-beta