i2UP接口文档

# 消息通知

SDK类名：/notifications/Notifications

# 消息 添加

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

# URL

//notifications

# Method

POST

# Request

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

# Response

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

# 消息 列表

SDK方法名：listNotifications;

# URL

//notifications

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 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 否 node1 node / vp / cls 的名称
          status String 否 OFFLINE node / vp / cls 的状态，离线/在线
          uuid String 否 @guid() node / vp / cls 的uuid
          res_type String 否 wk HA_UNKNOWN：未知；

HA_MASTER：主节点； HA_SLAVE：从节点； wk: 工作机; vp: 虚拟平台; cls：集群； node：节点； src: 源端; bk: 灾备机; tgt: 目标端; new_vp: 目标端; sync: 同步机; |           config_addr | String | 否 | ip | node / vp / cls 的地址 |           data_addr | String | 否 | ip | node / vp / cls 的数据地址，只有node有 |         latency | Number | 否 | | 仅复制规则有此值，当前延迟，单位ms |         latency_threshold | Number | 否 | | 仅复制规则有此值，复制规则设定的延迟阈值，单位ms |       time | Number | 否 | | 巡检通知时间，非巡检通知没这字段 |       all_status | Array | 否 | | 整体状态，非整体状态没这个字段 |         type | Number | 否 | | 和上面type一样 |         abnormal | Number | 否 | | 不正常的个数 |         normal | Number | 否 | | 正常的个数 |         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 | 否 | 172.20.79.69 | 超限节点IP |         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 | 否 | | 剩余天数，整形 |   total | Number | 否 | 2 | |   type | Number | 否 | | |

# 消息 单个

SDK方法名：describeNotifications;

# URL

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

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 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规则

# Response

名称 类型 必选 初始值 简介 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

# 消息 操作

SDK方法名：[action] + 'Notifications';

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

# URL

//notifications/operate

# Method

POST

# Request

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

# Response

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

# 配置 获取

SDK方法名：describeNotificationsConfig;

# URL

//notifications/config

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 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 否 短信模板

# 配置 更新

SDK方法名：updateNotificationsConfig;

# URL

//notifications/config

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
config Array 否 同 配置 获取 接口一样 10
  type Number 否 1
  p_sms_sw Number 否 1
  email_sw Number 否 0
  sms_sw Number 否 1
  sms_temp String 否

# Response

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

# 短信测试

SDK方法名：testNotificationsSms;

# URL

//notifications/sms_test

# Method

GET

# Request

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

# Response

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

# 邮件测试

SDK方法名：testNotificationsEmail;

# URL

//notifications/email_test

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 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规则

# Response

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

# 邮件模板 列表

# URL

//notifications/template

# Method

GET

# Request

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

# Response

名称 类型 必选 初始值 简介 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 否

# 邮件模板 修改

# URL

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

# Method

PUT

# Request

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

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功
Last Updated: 5/13/2020, 3:56:32 AM