消息通知

SDK类名：/common/Notifications;

消息接收管理-更新更多配置

SDK方法名：updateNotifyConf;

发送键值对，更新记录；

仅发送当前需要改的参数；

URL

/sys/settings/notify_conf

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
notify_contact_biz	Object	否	通知中心，普通联系人，默认包含
phone	String	否	电话，逗号分隔	11111111111
email	String	否	邮件，逗号分隔	test@info2sost.com
notify_contact_chk	Object	否	通知中心，巡检联系人
phone	String	否	电话，逗号分隔	11111111111
email	String	否	邮件，逗号分隔	test@info2sost.com
policy	Object	否	通知策略
every	String	否	month / season	month
days	String	否	第几天，逗号分隔	5,6
notify_contact_status	Object	否	通知中心，状态联系人
phone	String	否	电话，逗号分隔	11111111111
email	String	否	邮件，逗号分隔	test@info2sost.com
policy	Object	否	通知策略
every	String	否	hour / day	hour
gap	String	否	间隔小时/天数	4
notify_limit	String	否	通知中心，通知次数上限；	10
normal_notify_switch	Number		恢复正常通知 开关	0
sms_id	String		短信模板id
wechat_id	String		微信消息模板id
maintenance_switch	Number		运维平台开关	0
maintenance_ip	String		运维平台接口地址
maintenance_source_id	String		运维平台sourceID
maintenance_default_ip	String		运维平台默认告警设备绑定地址
maintenance_user_id	String		运维平台告警需要额外通知的员工工号
stop_alerts	Number		停止态是否告警： 0：否； 1：是；	1
audio_alert_notify	Number		音频告警通知
single_alert_loop_broadcast_times	Number		单次告警循环播报次数
custom_audio	String		自定义音频
alarm_shield	Object		json字符串，格式为 { "type":{ "node":true/false, "db":true/false, "rule":true/false, "task":true/false }, "level":{ "info":true/false, "warn":true/false, "report":true/false, "err":true/false, "fatal":true/false, "recover":true/false }, "code":[ 4000, 40001, 4002, ... ] }
type	Object
node	Boolean
db	Boolean
rule	Boolean
task	Boolean
level	Object
info	Boolean
warn	Boolean
report	Boolean
err	Boolean
fatal	Boolean
recover	Boolean
code	String		4000, 40001, 4002

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否
ret	Number	否	@mock=200	200
data	Object	否
message	String	否	@mock=success update to latest version	success update to latest version
code	Number	否	@mock=0	0

消息接收管理-获取配置

SDK方法名：listNotifyConf;

内容同更新配置

URL

/sys/settings/notify_conf

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
keys	Array	否	要获取的字段

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
notify_contact_biz	Object	否
phone	String	否		11111111111
email	String	否		test@info2sost.com
notify_contact_chk	Object	否
phone	String	否		11111111111
email	String	否		test@info2sost.com
policy	Object	否
every	String	否		1
days	String	否		5
notify_contact_status	Object	否
phone	String	否		11111111111
email	String	否		test@info2sost.com
policy	Object	否
every	String	否		3
gap	String	否		4
notify_limit	String	否		10
maintenance_switch	Number		运维平台开关	0
maintenance_ip	String		运维平台接口地址
maintenance_source_id	String		运维平台sourceID
maintenance_default_ip	String		运维平台默认告警设备绑定地址
maintenance_user_id	String		运维平台告警需要额外通知的员工工号

消息 添加

SDK方法名：addNotifications; 由底层触发，发送告警信息

URL

/notifications

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	String	否	规则/任务 类型	timing
uuid	String	否	规则/任务 uuid	82275AFD-97D0-15B4-D477-011E397113D6
msg	String	否	消息内容	规则/任务执行失败/成功/超时/策略取消
name	String	否	规则/任务 名称(base64加密)	timing_test
table	String	否	规则/任务 信息存放的表名
module	String	否	产生通知的模块，如node/vp/rep_backup/ha/nas/fsp_backup/fsp_move/vp_backup/vp_move/vp_recovery/vp_rep/timing_backup
cc_uuid	String		指定控制机uuid，多租户用来区别是具体哪一个租户

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。

消息 列表

SDK方法名：listNotifications;

URL

/notifications

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	Number	否	模块： 1：资源管理； 2：规则管理； 3：集群； 4：nas； 5：全服； 6：虚拟化； 7：定时； 8：高可用； 9: active; 10: cdm; 11: 云容灾; 100：巡检通知； 101：整体状态； 102：告警通知； 103：存储； 104：许可；
where_args[status]	Number	否	状态，0：未读，1：已读；
where_args[played]	Number		状态，0：未播放，1：已播放；
order_by	String	否		status
direction	String	否	ASC 增序排列	ASC

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
info_list	Array	否			2
uuid	String	否		@guid
type	Number	否	模块，1：资源管理；2：规则管理；3：集群；4：nas；5：全服；6：虚拟化；7：定时；8：高可用；100：巡检通知；101：整体状态；102：告警通知；103：存储；104：许可；
status	Number	否	状态，0：未读，1：已读；
create_time	Number	否	创建时间，时间戳	1539328080
update_time	Number	否	状态更新时间，时间戳	1539328081
user_uuid	String	否		@guid
title	String	否		@text
content	Object	否
rule	Array	否	不同模块不同名称，可出现：node, vp, rep_backup, cls, cls_rep, nas, fsp_backup, fsp_recovery, fsp_move, vp_backup, vp_recovery, vp_move, vp_rep, timing, ha,
name	String	否		规则1
status	String	否		STOP
uuid	String	否		@guid()
vm_name	String	否	vp rule 专有
config_addr	String	否	node / vp / cls 专有，地址，其他模块没这字段
data_addr	String	否	node 专有，数据地址，其他模块没这字段
relevant_res	Array	否	规则/任务专有（除node / vp / cls外的所有模块），相关节点/vp/cls列表		2
name	String	否	node / vp / cls 的名称	node1
status	String	否	node / vp / cls 的状态，离线/在线	OFFLINE
uuid	String	否	node / vp / cls 的uuid	@guid()
res_type	String	否	HA_UNKNOWN：未知； HA_MASTER：主节点； HA_SLAVE：从节点； wk: 工作机; vp: 虚拟平台; cls：集群； node：节点； src: 源端; bk: 灾备机; tgt: 目标端; new_vp: 目标端; sync: 同步机;	wk
config_addr	String	否	node / vp / cls 的地址	ip
data_addr	String	否	node / vp / cls 的数据地址，只有node有	ip
latency	Number	否	仅复制规则有此值，当前延迟，单位ms
latency_threshold	Number	否	仅复制规则有此值，复制规则设定的延迟阈值，单位ms
time	Number	否	巡检通知时间，非巡检通知没这字段
all_status	Array	否	整体状态，非整体状态没这个字段
type	Number	否	和上面type一样	2
abnormal	Number	否	不正常的个数	3
normal	Number	否	正常的个数	1
maintenance	Number		维护节点数量	2
module	String	否	模块名称，没翻译，内容为： res：资源； node：节点； vp：虚拟平台； cls：集群； compare：比较任务； rule：复制规则； rep_backup：复制规则； rep_recovery：复制规则-还原； nas：NAS同步规则； fsp：全服务器保护； fsp_backup：全服务器备份； fsp_recovery：全服务器还原； fsp_move：全服务器迁移； vp_backup：虚机备份任务； vp_recovery：虚机还原任务； vp_move：虚机迁移任务； vp_rep：虚机复制规则； vp_file_recovery：虚机文件级恢复任务； timing：定时备份； timing_backup：定时备份任务； timing_recovery：定时备份-还原； ha：高可用； up_monitor：平台监控； dto：DTO； dto_storage：DTO存储； dto_sync_host：DTO同步主机； dto_agent_host：DTO生产主机； dto_sync_rule：DTO同步规则； dto_recovery_rule：DTO还原规则； dto_compare_rule：DTO比较规则；
statistics	Array	否	同 统计报表 模块下获取列表内容一样；随整体状态返回
alarm	Array	否	告警通知
name	String	否	规则名称	bk1
module	String	否	规则类型	timing
msgx	String	否	告警内容	磁盘已满，请清理空间！
storage	Object	否	存储监控
bk_node_name	String	否	超限节点名称	test
bk_ip	String	否	超限节点IP	172.20.79.69
device_info	Array	否	超限磁盘列表
dev_mount	String	否	磁盘名称	disk
threshold	Number	否	告警阈值百分比	80
dev_used_percent	Number	否	实际使用百分比	85
license	Array	否	许可过期告警
sn	String	否	序列号
feature	String	否	功能，形如：coopy
alarm_for	String	否	是否已经过期，已经过期/将要过期：expired/will_expire
expired_type	String	否	过期类型，过有效期/过维保期：validity_expired/maint_expired
expired_date	String	否	过期日期，形如：2020-1-12
days_remaining	String	否	剩余天数，整形
normal	Array
name	String		规则名称
module	String		模块名称
msg	String		消息内容	异常状态已恢复正常
is_normal	Number		0：异常消息； 1：恢复正常消息 ( 高可用； 资源：节点，虚拟平台，集群； 复制规则； NAS; 全服保护，全服迁移； 整机复制； 虚机规则：备份，赋值，迁移，恢复； 定时备份； active_rule； )	0
total	Number	否		2
type	Number	否

消息 单个

SDK方法名：describeNotifications;

URL

/notifications/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
notifications	Object	否
username	String	否		admin
id	String	否		167
uuid	String	否		B12622A4-4F19-F844-3135-21E78DCD8649
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
title	String	否		虚拟平台规则状态异常
content	Object	否
vp_backup	Array	否
status	String	否		UNKNOWN
uuid	String	否		199EDA68-3512-480A-8355-A0E9C2DA1587
name	String	否		9_21
vm_name	String	否		ls_vp_test_move
code	Number	否		11116079
message	String	否		[11116079] rpc.vp.rule_not_exist
vp_recovery	Array	否
status	String	否		STOP
uuid	String	否		1725C80F-4464-ED8A-63DA-A7B9CE611628
name	String	否		vp_bk
vm_name	String	否		ls_vp_test
progress	String	否		-6089.0
vp_rep	Array	否
status	String	否		UNKNOWN
uuid	String	否		92D0A8D7-3969-1455-7C7A-DC6D1709BD7E
name	String	否		teasd
vm_name	String	否		win2012_ctrl
code	Number	否		11116085
message	String	否		[11116085] rpc.vp.params_error
type	Number	否		6
status	Number	否		1
create_time	Number	否		1539657352
update_time	String	否

消息 数量

SDK方法名：describeNotificationsCount;

URL

/notifications/count

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
count	Array	否			10
type	Number	否	0：所有消息；	0	+1
read	Number	否			1-100
total	Number	否			1-100
unread	Number	否			1-100
played	Number		已播放
unplayed	Number		未播放

消息 操作

SDK方法名：operateNotifications;

删除，标记已读，某类型/全部已读；

URL

/notifications/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
operate	String	否	delete：删除；read：标记已读；add:添加; play: 标记未已播放
uuids	Array	否	delete 专用，要删的uuid
type	Number	否	read play 专用，需要标记已读的类型，同获取列表的类型一样

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。

配置 获取

SDK方法名：describeNotificationsConfig;

URL

/notifications/config

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
config	Array	否			11
type	Number	否	同消息列表的类型一样；	100	+1
p_sms_sw	Number	否	站内信开关		0-1
email_sw	Number	否	邮件开关		0-1
sms_sw	Number	否	短信开关		0-1
sms_temp	String	否	短信模板
wechat_sw	Number		微信开关
maintenance_sw	Number		运维开关	0
principal	String		告警负责人	test
kafka_sw	Number		Kafka开关	0
webhook_sw	Number		webhook渠道开关	0
webhook_uuid	String		webhook渠道uuid
content_temp_uuid	String		内容模板uuid

配置 更新

SDK方法名：updateNotificationsConfig;

URL

/notifications/config

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
config	Array	否	同 配置 获取 接口一样		10
type	Number	否	消息类型	1
p_sms_sw	Number	否	站内信开关	1
email_sw	Number	否	email开关	0
sms_sw	Number	否	短信开关	1
sms_temp	String	否	短信模板
wechat_sw	Number		微信开关	0
maintenance_sw	Number		运维开关	0
principal	String		告警负责人
kafka_sw	Number		Kafka开关	0
webhook_sw	Number		webhook渠道开关	0
webhook_uuid	String		webhook渠道uuid
content_temp_uuid	String		内容模板uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。

短信测试

SDK方法名：testNotificationsSms;

URL

/notifications/sms_test

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
temp_id	String	否	短信模板，模板ID（需要模板变量${msg}），对于那几个需要再短信服务器上配置模板的，填ID（必填），对于其他短信平台，不用传（页面上也不显示这个框）；
mobile	String	否	手机号，只支持一个号	13123456789

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。

邮件测试

SDK方法名：testNotificationsEmail;

URL

/notifications/email_test

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
email	String	否	测试地址	lis@info2soft.com

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。

重置通知次数

SDK方法名：resetNotificationsTimes;

URL

/notifications/reset_notify_times

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。

邮件模板 列表

SDK方法名：listEmailTemplate;

URL

/notifications/template

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	String	否	与通知类型一致，默认公用：200；测试邮件为：201；刚进列表不传，用户选择类型后传；
order_by	String	否		status
direction	String	否	ASC 增序排列	ASC

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
info_list	Array	否
temp_type	String	否	与通知类型一致，默认公用：200；测试邮件为：201；
temp_uuid	String	否	（不传type没有）uuid
lang	String	否	（不传type没有）模板语言：english，zh_cn，zh_tw
content	String	否	（不传type没有）模板内容，html
content_default	String	否	（不传type没有）默认模板内容，html
comment	String	否	（不传type没有）备注
random_str	String	否

邮件模板 修改

SDK方法名：modifyEmailTemplate;

URL

/notifications/template/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
content	String	否	模板内容，html
comment	String	否	备注
random_str	String	否	修改锁

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功

邮件模板 操作

SDK方法名：operateNotificationsTemplate;

URL

/notifications/template/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String		模板uuid
operate	String		重置：reset

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object
code	Number			0
message	String
msg	String
ret	Number			200