Dataphin支持自定义消息渠道,以满足不同的客制化场景。本文为您介绍如何自定义消息发送渠道。
使用说明
消息发送渠道支持在每个租户级别进行设置,您可以根据您所在组织的要求进行不同的配置。
消息渠道关闭后,配置的告警消息将无法发送,为确保告警消息可顺利发送,请开启自定义消息渠道。
权限说明
超级管理员和系统管理员支持编辑消息渠道;其他用户支持查看消息渠道。
自定义消息渠道
在Dataphin首页,单击顶部菜单栏的管理中心。
按照下图指引,进入新增自定义消息渠道页面。
在新增自定义消息渠道页面,配置参数。
参数
描述
渠道名称
自定义消息渠道的名称。不支持以空格开头,当前租户下名称唯一。例如:微信消息渠道。
描述
建议结合业务场景说明。不超过128字符。例如:用于接收微信群告警信息。
信息发送URL
信息发送的URL地址。
请求方式
系统支持选择POST、GET。
说明选择POST请求参数配置支持Headers、Parameters和Body。
选择GET请求参数配置支持Headers、Parameters。
请求参数配置
Headers:单击+新建按钮,配置Headers参数。
key:自定义key值,Key值不可重名,在所有参数中参数名唯一。
value:支持自定义输入,包括常量及内置的参数。详情请参见自定义消息渠道支持的元数据。
类型:下拉选框可选择String、Double、Long、Boolean。
参数加密:默认关闭。开启加密时,参数值展示为******。
重要Headers和Body中的常量的参数值可支持配置参数加密,变量型参数值不可加密。
加密仅在Dataphin编辑时脱敏、存储时加密。在与渠道对接时,仍然为明文传输。若需加密传输,则需在配置时就是用加密后的文本,在渠道应用处理时进行解密。
Parameters:单击+新建按钮,配置Parameters参数。
key:自定义key值,Key值不可重名,在所有参数中参数名唯一。
value:选择value值。支持自定义输入,包括常量及内置的参数。详情请参见自定义消息渠道支持的元数据。
操作:
如需编辑Parameters参数,单击操作列下的图标。
如需删除Parameters参数,单击操作列下的图标。
Body:单击+新建按钮,配置Body参数。
key:自定义key值,Key值不可重名,在所有参数中参数名唯一。
value:支持自定义输入,包括常量及内置的参数。详情请参见自定义消息渠道支持的元数据。
类型:下拉选框可选择String、Double、Long、Boolean、JSON。
参数加密:默认关闭。开启加密时,参数值展示为******。
操作:
如需编辑Body参数,单击操作列下的图标。
如需删除Body参数,单击操作列下的图标。
测试:单击测试,在测试请求发送对话框,配置测试参数后,单击开始测试。
请求(Request)文本框展示请求详情。单击图标,可复制请求详情。
请求体仅Post请求方式出现。
响应(Response)文本框展示响应详情。单击图标,可复制响应详情。
说明若Headers自身携带参数,您需在测试时输入参数的配置值。
发送结果解析
系统支持根据HTTP状态码、根据HTTP状态码及响应结果。
根据HTTP状态码:状态码为2xx时,即认为发送成功。
根据HTTP状态码及响应结果:自定义配置发送条件。
查询结果解析
key:可下拉选框选择key值或自定义key值。
value:自定义value值。
说明若状态码为2xx,且满足发送成功条件,则识别为发送成功。
若状态码!=2xx,则识别为发送失败。
若状态码为2xx,且满足发送失败条件,则识别为发送失败。
其他条件情况下,则识别为发送中,会持续轮训直到获取到发送成功或失败。
您可自行输入${response.key}的方式获取响应中的key值。
参数
描述
结果查询
默认关闭,可选择开启。
关闭:关闭时,发送完成,则任务发送成功。
开启:开启时,发送完成,则需要轮询结果,展示在告警中心。
结果查询URL
结果查询的URL地址。
请求方式
系统支持选择POST、GET。
说明选择POST请求参数配置支持Headers、Parameters和Body。
选择GET请求参数配置支持Headers、Parameters。
请求参数配置
Headers:单击+新建按钮,配置Headers参数。
key:自定义key值,Key值不可重名,在所有参数中参数名唯一。
value:支持自定义输入,包括常量及内置的参数。详情请参见自定义消息渠道支持的元数据。
类型:下拉选框可选择String、Double、Long、Boolean。
参数加密:默认关闭。开启加密时,参数值展示为******。
Parameters:单击+新建按钮,配置Parameters参数。
key:自定义key值,Key值不可重名,在所有参数中参数名唯一。
value:选择value值。支持自定义输入,包括常量及内置的参数。详情请参见自定义消息渠道支持的元数据。
操作:
如需编辑Parameters参数,单击操作列下的图标。
如需删除Parameters参数,单击操作列下的图标。
Body:单击+新建按钮,配置Body参数。
key:自定义key值,Key值不可重名,在所有参数中参数名唯一。
value:支持自定义输入,包括常量及内置的参数。详情请参见自定义消息渠道支持的元数据。
类型:下拉选框可选择String、Double、Long、Boolean、JSON。
参数加密:默认关闭。开启加密时,参数值展示为******。
操作:
如需编辑Body参数,单击操作列下的图标。
如需删除Body参数,单击操作列下的图标。
测试:单击测试,在测试请求发送对话框,配置测试参数后,单击开始测试。
请求(Request)文本框展示请求详情。单击图标,可复制请求详情。
请求体仅Post请求方式出现。
响应(Response)文本框展示响应详情。单击图标,可复制响应详情。
说明若Headers自身携带参数,您需在测试时输入参数的配置值。
查询结果解析
key:可下拉选框选择key值或自定义key值。
value:自定义value值。
说明若状态码为2xx,且满足发送成功条件,则识别为发送成功。
若状态码!=2xx,则识别为发送失败。
若状态码为2xx,且满足发送失败条件,则识别为发送失败。
其他条件情况下,则识别为发送中,会持续轮训直到获取到发送成功或失败。
您可自行输入${response.key}的方式获取响应中的key值。
单击发送测试消息,测试消息用于测试自定义短信服务是否配置成功。
参数
描述
接收人
下拉选框选择接收人。
语音消息
默认填充这是一条来自Dataphin的测试消息。
您可自定义编辑,不超过128字符。
单击保存,完成自定义消息渠道设置。