i2UP接口文档

消息通知

February 26, 2024About 22 min

消息通知

SDK类名：/common/Notifications;

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

SDK方法名：updateNotifyConf;

发送键值对，更新记录；

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

URL

/sys/settings/notify_conf

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
notify_contact_bizObject否通知中心，普通联系人，默认包含
  phoneString否电话，逗号分隔11111111111
  emailString否邮件，逗号分隔test@info2sost.com
notify_contact_chkObject否通知中心，巡检联系人
  phoneString否电话，逗号分隔11111111111
  emailString否邮件，逗号分隔test@info2sost.com
  policyObject否通知策略
    everyString否month / seasonmonth
    daysString否第几天，逗号分隔5,6
notify_contact_statusObject否通知中心，状态联系人
  phoneString否电话，逗号分隔11111111111
  emailString否邮件，逗号分隔test@info2sost.com
  policyObject否通知策略
    everyString否hour / dayhour
    gapString否间隔小时/天数4
notify_limit_typeString（备份中心）
通知中心，通知周期类型：
day：天；
week：周；
month：月；
notify_limitString否通知中心，通知次数上限；10
normal_notify_switchNumber恢复正常通知 开关0
sms_idString短信模板id
wechat_idString微信消息模板id
stop_alertsNumber停止态是否告警：
0：否；
1：是；		1
audio_alert_notifyNumber音频告警通知
single_alert_loop_broadcast_timesNumber单次告警循环播报次数
custom_audioString自定义音频
alarm_shieldObjectjson字符串，格式为
{
"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, ...
]
}
  typeObject
    nodeBoolean
    dbBoolean
    ruleBoolean
    taskBoolean
  levelObject
    infoBoolean
    warnBoolean
    reportBoolean
    errBoolean
    fatalBoolean
    recoverBoolean
  codeString4000, 40001, 4002
alarm_configObject数据库同步设置
  alarm_intervalNumber
  max_analyze_halt_tmNumber
  max_delayNumber
  max_err_table_numNumber
  max_err_dml_numNumber
  max_err_ddl_numNumber
  max_cpuStringCPU占用阈值（%） 默认值80
  max_memString内存占用阈值（%） 默认值80
  max_netString网络传输速率（MB/s）默认值0 （即默认不监控）
  max_diskString磁盘占用阈值（% ）默认值80
  db_healthyObject
    max_db_ts_usageNumber
    max_db_asm_usageNumber
    db_headroomNumber

Response

名称类型必选简介Mock初始值Mock规则
msgString否
retNumber否@mock=200200
dataObject否
  messageString否@mock=success update to latest versionsuccess update to latest version
  codeNumber否@mock=00

消息接收管理-获取配置

SDK方法名：listNotifyConf;

内容同更新配置

URL

/sys/settings/notify_conf

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
keysArray否要获取设置的key：
notify_limit：通知次数限制:;
normal_notify_switch：恢复正常通知开关；
notify_contact_biz：普通联系人设置；
notify_contact_chk：巡检通知联系人设置；
notify_contact_status：整体状态联系人通知；
sms_id：短信模板ID；
wechat_id：微信模板ID；
stop_alerts：停止态告警开关；
alarm_shield：数据库同步-告警屏蔽；
alarm_config：数据库同步-告警配置；
audio_alert_notify：音频告警通知开关；
custom_audio：自定义音频；
single_alert_loop_broadcast_times：单次告警循环播报次数；		[
"notify_limit",
"normal_notify_switch",
"notify_contact_biz",
"notify_contact_chk",
"notify_contact_status",
"sms_id",
"wechat_id",
"stop_alerts",
"alarm_shield",
"alarm_config",
"custom_audio",
"single_alert_loop_broadcast_times",
"audio_alert_notify"
]

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。
  notify_contact_bizObject否
    phoneString否11111111111
    emailString否test@info2sost.com
  notify_contact_chkObject否
    phoneString否11111111111
    emailString否test@info2sost.com
    policyObject否
      everyString否1
      daysString否5
  notify_contact_statusObject否
    phoneString否11111111111
    emailString否test@info2sost.com
    policyObject否
      everyString否3
      gapString否4
  notify_limit_typeString（备份中心）
通知中心，通知周期类型：
day：天；
week：周；
month：月；
  notify_limitString否10
  maintenance_switchNumber运维平台开关0
  maintenance_ipString运维平台接口地址
  maintenance_source_idString运维平台sourceID
  maintenance_default_ipString运维平台默认告警设备绑定地址
  maintenance_user_idString运维平台告警需要额外通知的员工工号

消息 添加

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

URL

/notifications

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
typeString否规则/任务 类型 用于标题展示
timing - 定时备份
nas - NAS同步规则
compare - 比较任务
ha - 高可用
rule - 复制规则
fsp - 整机保护
bigdata - 大数据备份
storage_unit - 存储单元		timing
uuidString否规则/任务 uuid82275AFD-97D0-15B4-D477-011E397113D6
msgString否消息内容规则/任务执行失败/成功/超时/策略取消
nameString否规则/任务 名称(base64编码)timing_test
cc_uuidString指定控制机uuid，多租户用来区别是具体哪一个租户

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。

消息 列表

SDK方法名：listNotifications;

URL

/notifications

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
typeNumber否模块：
资源管理: res；
规则管理: rule；
集群: cls；
NAS文件复制 : nas；
HDFS同步: hdfs;
整机保护: fsp；
虚拟化: vp；
定时: timing；
高可用: ha；
Oracle同步: active;
副本管理: cdm;
云容灾: cloud;
巡检通知: routing_inspection；
整体状态: all_status；
告警通知: alarm；
存储: storage；
许可: lic；
备端数据安全：guard_data；

工行：
备份规则：backup_rule；
恢复任务：recovery_rule；
where_args[status]Number否状态，0：未读，1：已读；
where_args[played]Number状态，0：未播放，1：已播放；
order_byString否status
directionString否ASC 增序排列ASC
lic_alertNumber许可弹出框传10

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。
  info_listArray否2
    uuidString否@guid
    typeNumber否模块：
资源管理: res；
规则管理: rule；
集群: cls；
NAS文件复制 : nas；
HDFS同步: hdfs;
整机保护: fsp；
虚拟化: vp；
定时: timing；
高可用: ha；
Oracle同步: active;
副本管理: cdm;
云容灾: cloud;
巡检通知: routing_inspection；
整体状态: all_status；
告警通知: alarm；
存储: storage；
许可: lic；
    statusNumber否状态，0：未读，1：已读；
    create_timeNumber否创建时间，时间戳1539328080
    update_timeNumber否状态更新时间，时间戳1539328081
    user_uuidString否@guid
    titleString否@text
    contentObject否
      nodeArray否不同模块不同名称，可出现：模块：
容灾节点: node；
虚拟平台：vp；
管理服务器：npsvr；
云平台：cloud；
容灾集群：cls
复制规则：rep_backup；
nas复制规则：nas；
hdfs同步：hdfs；
整机保护：fsp_backup；
整机权益：fsp_move；
副本管理：cdm；
远程复制：cdm_remote_coop；
云容灾整机复制：cloud_compl_rep；
云容灾接管演练：cloud_rule；
虚机备份：vp_backup；
虚机恢复：vp_recovery；
虚机迁移：vp_move；
虚机复制：vp_rep；
应用保护：timing_backup;
DTO：dto；
高可用：ha
        nameString否规则1
        statusString否STOP
        uuidString否@guid()
        vm_nameString否vp rule 专有
        config_addrString否node / vp / cls 专有，地址，其他模块没这字段
        data_addrString否node 专有，数据地址，其他模块没这字段
        relevant_resArray否规则/任务专有（除node / vp / cls外的所有模块），相关节点/vp/cls列表2
          nameString否node / vp / cls / 大数据平台 的名称node1
          statusString否node / vp / cls 的状态，离线/在线OFFLINE
          uuidString否node / vp / cls 的uuid@guid()
          res_typeString否HA_UNKNOWN：未知；
HA_MASTER：主节点；
HA_SLAVE：从节点；
wk: 工作机;
vp: 虚拟平台;
cls：集群；
node：节点；
src: 源端;
bk: 灾备机;
tgt: 目标端;
new_vp: 目标端;
sync: 同步机;		wk
          config_addrString否node / vp / cls ：管理地址;ip
          data_addrString否node / vp / cls 的数据地址，只有node有ip
          sync_addrString大数据平台：同步主机地址
          hdfs_addrString大数据平台：hdfs地址；
          hive_addrString大数据平台：hive地址；
        latencyNumber否仅复制规则有此值，当前延迟，单位ms
        latency_thresholdNumber否仅复制规则有此值，复制规则设定的延迟阈值，单位ms
      timeNumber否巡检通知时间，非巡检通知没这字段
      all_statusArray否整体状态，非整体状态没这个字段
        typeNumber否和上面type一样2
        abnormalNumber否不正常的个数3
        normalNumber否正常的个数1
        maintenanceNumber维护节点数量2
        moduleString否模块名称，没翻译，内容为：
模块：
容灾节点: node；
虚拟平台：vp；
管理服务器：npsvr；
云平台：cloud；
容灾集群：cls
复制规则：rep_backup；
nas复制规则：nas；
hdfs同步：hdfs；
整机保护：fsp_backup；
整机权益：fsp_move；
副本管理：cdm；
远程复制：cdm_remote_coop；
云容灾整机复制：cloud_compl_rep；
云容灾接管演练：cloud_rule；
虚机备份：vp_backup；
虚机恢复：vp_recovery；
虚机迁移：vp_move；
虚机复制：vp_rep；
应用保护：timing_backup;
DTO：dto；
高可用：ha
      statisticsArray否同 统计报表 模块下获取列表内容一样；随整体状态返回
      alarmArray否告警通知
        nameString否规则名称bk1
        moduleString否规则类型timing
        msgxString否告警内容磁盘已满，请清理空间！
        alarm_dataObject有此字段，说明站内信显示的内容需要页面来翻译
          alarm_keyString具体消息key，目前包括：
disk_will_full、disk_has_been_full、vp_storage_alarm
      storageObject否存储监控
        bk_node_nameString否超限节点名称test
        bk_ipString否超限节点IP172.20.79.69
        device_infoArray否超限磁盘列表
          dev_mountString否磁盘名称disk
          thresholdNumber否告警阈值百分比80
          dev_used_percentNumber否实际使用百分比85
      licenseArray否许可过期告警0-4
        snString否序列号@string('number', 10)
        group_snString组序列号
        featureString否功能，形如：coopy@string
        alarm_forString否是否已经过期，已经过期/将要过期：expired/will_expire@pick('', 'expired', 'will_expire')
        expired_typeString否过期类型，过有效期/过维保期/激活期：validity_expired/maint_expired/act_expired
        expired_dateString否过期日期，形如：2020-1-12@date
        days_remainingString否剩余天数，整形@integer(0, 100)
      normalArray
        nameString规则名称
        moduleString模块名称
        msgString消息内容异常状态已恢复正常
      guard_dataArray
        node_nameString节点名称
        config_addrString节点管理地址
        im_subjectString篡改的程序
        im_objectString被篡改的路径
        start_timeString开始时间
        end_timeString结束时间
        read_countNumber被拒绝读的次数
        write_countNumber被拒绝写的次数
    is_normalNumber0：异常消息；
1：恢复正常消息
(
高可用；
资源：节点，虚拟平台，集群；
复制规则；
NAS;
全服保护，全服迁移；
整机复制；
虚机规则：备份，赋值，迁移，恢复；
定时备份；
active_rule；
)		0
  totalNumber否2
  typeNumber否

消息 单个

SDK方法名：describeNotifications;

URL

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

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。
  notificationsObject否
    uuidString否@guid
    typeNumber否模块：
资源管理: res；
规则管理: rule；
集群: cls；
NAS文件复制 : nas；
HDFS同步: hdfs;
整机保护: fsp；
虚拟化: vp；
定时: timing；
高可用: ha；
Oracle同步: active;
副本管理: cdm;
云容灾: cloud;
巡检通知: routing_inspection；
整体状态: all_status；
告警通知: alarm；
存储: storage；
许可: lic；
    statusNumber否状态，0：未读，1：已读；
    create_timeNumber否创建时间，时间戳1539328080
    update_timeNumber否状态更新时间，时间戳1539328081
    user_uuidString否@guid
    titleString否@text
    contentObject否
      ruleArray否不同模块不同名称，可出现：node, vp,
rep_backup, cls, cls_rep, nas, fsp_backup, fsp_recovery, fsp_move, vp_backup, vp_recovery, vp_move, vp_rep, timing, ha,
        nameString否规则1
        statusString否STOP
        uuidString否@guid()
        vm_nameString否vp rule 专有
        config_addrString否node / vp / cls 专有，地址，其他模块没这字段
        data_addrString否node 专有，数据地址，其他模块没这字段
        relevant_resArray否规则/任务专有（除node / vp / cls外的所有模块），相关节点/vp/cls列表2
          nameString否node / vp / cls / 大数据平台 的名称node1
          statusString否node / vp / cls 的状态，离线/在线OFFLINE
          uuidString否node / vp / cls 的uuid@guid()
          res_typeString否HA_UNKNOWN：未知；
HA_MASTER：主节点；
HA_SLAVE：从节点；
wk: 工作机;
vp: 虚拟平台;
cls：集群；
node：节点；
src: 源端;
bk: 灾备机;
tgt: 目标端;
new_vp: 目标端;
sync: 同步机;		wk
          config_addrString否node / vp / cls ：管理地址;ip
          data_addrString否node / vp / cls 的数据地址，只有node有ip
          sync_addrString大数据平台：同步主机地址
          hdfs_addrString大数据平台：hdfs地址；
          hive_addrString大数据平台：hive地址；
        latencyNumber否仅复制规则有此值，当前延迟，单位ms
        latency_thresholdNumber否仅复制规则有此值，复制规则设定的延迟阈值，单位ms
      timeNumber否巡检通知时间，非巡检通知没这字段
      all_statusArray否整体状态，非整体状态没这个字段
        typeNumber否和上面type一样2
        abnormalNumber否不正常的个数3
        normalNumber否正常的个数1
        maintenanceNumber维护节点数量2
        moduleString否模块名称，没翻译，内容为：
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比较规则；
      statisticsArray否同 统计报表 模块下获取列表内容一样；随整体状态返回
      alarmArray否告警通知
        nameString否规则名称bk1
        moduleString否规则类型timing
        msgxString否告警内容磁盘已满，请清理空间！
        alarm_dataObject有此字段，说明站内信显示的内容需要页面来翻译
          alarm_keyString具体消息key，目前包括：
disk_will_full、disk_has_been_full、vp_storage_alarm
      storageObject否存储监控
        bk_node_nameString否超限节点名称test
        bk_ipString否超限节点IP172.20.79.69
        device_infoArray否超限磁盘列表
          dev_mountString否磁盘名称disk
          thresholdNumber否告警阈值百分比80
          dev_used_percentNumber否实际使用百分比85
      licenseArray否许可过期告警0-4
        snString否序列号@string('number', 10)
        group_snString组序列号
        featureString否功能，形如：coopy@string
        alarm_forString否是否已经过期，已经过期/将要过期：expired/will_expire@pick('', 'expired', 'will_expire')
        expired_typeString否过期类型，过有效期/过维保期/激活期：validity_expired/maint_expired/act_expired
        expired_dateString否过期日期，形如：2020-1-12@date
        days_remainingString否剩余天数，整形@integer(0, 100)
      normalArray
        nameString规则名称
        moduleString模块名称
        msgString消息内容异常状态已恢复正常
      guard_dataArray
        node_nameString节点名称
        config_addrString节点管理地址
        im_subjectString篡改的程序
        im_objectString被篡改的路径
        start_timeString开始时间
        end_timeString结束时间
        read_countNumber被拒绝读的次数
        write_countNumber被拒绝写的次数
    is_normalNumber0：异常消息；
1：恢复正常消息
(
高可用；
资源：节点，虚拟平台，集群；
复制规则；
NAS;
全服保护，全服迁移；
整机复制；
虚机规则：备份，赋值，迁移，恢复；
定时备份；
active_rule；
)		0
  totalNumber否2
  typeNumber否

消息 数量

SDK方法名：describeNotificationsCount;

URL

/notifications/count

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。
  countArray否10
    typeNumber否0：所有消息；0+1
    readNumber否1-100
    totalNumber否1-100
    unreadNumber否1-100
    playedNumber已播放
    unplayedNumber未播放

消息 操作

SDK方法名：operateNotifications;

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

URL

/notifications/operate

Method

POST

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。

消息 删除

方法名：deleteNotifications;

URL

/notifications

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
uuidsArray消息uuid数组

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString[0] 操作成功
  codeNumber0

配置 获取

SDK方法名：describeNotificationsConfig;

URL

/notifications/config

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。
  configArray否11
    typeNumber否同消息列表的类型一样；100+1
    p_sms_swNumber否站内信开关0-1
    email_swNumber否邮件开关0-1
    sms_swNumber否短信开关0-1
    sms_tempString否短信模板
    wechat_swNumber微信开关
    maintenance_swNumber运维开关0
    principalString告警负责人test
    kafka_swNumberKafka开关0
    webhook_swNumberwebhook渠道开关0
    webhook_uuidStringwebhook渠道uuid
    content_temp_uuidString内容模板uuid
    snmp_swNumberSNMP开关0

配置 更新

SDK方法名：updateNotificationsConfig;

URL

/notifications/config

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
configArray否同 配置 获取 接口一样10
  typeNumber否消息类型1
  p_sms_swNumber否站内信开关1
  email_swNumber否email开关0
  sms_swNumber否短信开关1
  sms_tempString否短信模板
  wechat_swNumber微信开关0
  maintenance_swNumber运维开关0
  principalString告警负责人
  kafka_swNumberKafka开关0
  webhook_swNumberwebhook渠道开关0
  webhook_uuidStringwebhook渠道uuid
  content_temp_uuidString内容模板uuid
  snmp_swNumberSNMP开关0

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。

短信测试

SDK方法名：testNotificationsSms;

URL

/notifications/sms_test

Method

POST

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。

邮件测试

SDK方法名：testNotificationsEmail;

URL

/notifications/email_test

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。

重置通知次数

SDK方法名：resetNotificationsTimes;

URL

/notifications/reset_notify_times

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功。

邮件模板 列表

SDK方法名：listEmailTemplate;

URL

/notifications/template

Method

GET

Request

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

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功
  info_listArray否
    temp_typeString否与通知类型一致，默认公用：200；测试邮件为：201；
    temp_uuidString否（不传type没有）uuid
    langString否（不传type没有）模板语言：english，zh_cn，zh_tw
    contentString否（不传type没有）模板内容，html
    content_defaultString否（不传type没有）默认模板内容，html
    commentString否（不传type没有）备注
    random_strString否

邮件模板 修改

SDK方法名：modifyEmailTemplate;

URL

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

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
contentString否模板内容，html
commentString否备注
random_strString否修改锁

Response

名称类型必选简介Mock初始值Mock规则
retNumber否200
msgString否
dataObject否
retNumber否200
msgString否
dataObject否
  codeNumber否0
  messageString否[0] 操作成功
Last update: 2/26/2024, 5:49:44 PM
Contributors: ganl