zyc_data_rsync/doc_json/event_client.json

{
  "apiVersion": "1.0",
  "apis": [
    {
      "description": "acceptEvent",
      "operations": [
        {
          "method": "GET",
          "summary": "受理事件",
          "notes": "受理事件",
          "nickname": "acceptEvent",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "事件ID,可通过/event/client/getEventList接口获得",
              "name": "eventId",
              "paramType": "path",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "void"
        }
      ],
      "path": "/event/client/accept/{eventId}"
    },
    {
      "description": "getEventData",
      "operations": [
        {
          "method": "GET",
          "summary": "第三方系统根据系统ID，实时获取BMC产生的告警",
          "notes": "第三方系统根据系统ID，实时获取BMC产生的告警",
          "nickname": "getEventData",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "第三方系统ID。可通过系统管理->监控配置->告警推送标准化->第三方标识获得",
              "name": "thirdSysId",
              "paramType": "path",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "第三方获取事件列表"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "第三方获取事件列表"
        }
      ],
      "path": "/event/client/get3rdEventData/{thirdSysId}"
    },
    {
      "description": "getEventList",
      "operations": [
        {
          "method": "POST",
          "summary": "查询事件列表",
          "notes": "查询事件列表",
          "nickname": "getEventList",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "查询事件类型(未受理：unaccepted_event_view 已受理：accepted_event_view)",
              "name": "viewType",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "域ID,可通过/login接口获得",
              "name": "domainId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "事件名称",
              "name": "eventName",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "资源类型",
              "name": "resType",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "资源IP地址",
              "name": "resIp",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "资源名称",
              "name": "resName",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "是否显示未受理但已恢复的告警，默认false",
              "name": "relRecoveredEvent",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "事件级别，默认全部(1：信息，2：未知，3：警告，4：次要，5：主要，6：严重)",
              "name": "level",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "是否分页，默认不分页(0：不分页，1：分页)",
              "name": "isPageing",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "列表分页的请求页数，默认1",
              "name": "pageIndex",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "IP或者是资源名称",
              "name": "ipOrResName",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "事件类型",
              "name": "eventTypes",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "name": "resRange",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "选填，排序字段值,只支持一个排序sortColumn和sortType 必须同时不为空才生效字段",
              "name": "sortColumn",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "选填，排序字段值,只支持一个排序sortColumn和sortType 必须同时不为空才生效字段，无默认值",
              "name": "sortType",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "事件对应资源所属的主资源的treenodeid, 如果事件对应的资源是主资源,就放他自己的",
              "name": "mainTreeNodeId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "tree节点ID，如：base为00；host为00.01，AIX就是00.01.01 如果是此模板为子资源模板，此列为空",
              "name": "treeNodeId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "列表分页中每页条数，可不传，默认20",
              "name": "pageSize",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "name": "eventTimeType",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "告警首次发生时间",
              "name": "eventTimeStart",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "告警结束时间",
              "name": "eventTimeEnd",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "事件列表数据"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "事件列表数据"
        }
      ],
      "path": "/event/client/getEventList"
    },
    {
      "description": "getLogAlarmList",
      "operations": [
        {
          "method": "POST",
          "summary": "获取日志事件列表",
          "notes": "getLogAlarmList",
          "nickname": "getLogAlarmList",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "是否分页，默认不分页",
              "name": "isPageing",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "列表分页中每页条数，可不传，默认20",
              "name": "pageSize",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "列表分页的请求页数，默认1",
              "name": "pageIndex",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "日志类型（Window：logmonitor-plugin-windows Syslog：logmonitor-plugin-syslog）",
              "name": "plugId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "告警级别，可穿多个以“，”分割(严重：CRITICAL 主要： MAJOR 次要： MINOR 警告： WARNING 信息： CLEARED)",
              "name": "alarmLevels",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "IP地址",
              "name": "alarmsModeContext",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "日志事件列表数据"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "日志事件列表数据"
        }
      ],
      "path": "/event/client/getLogAlarmList"
    }
  ],
  "basePath": "/adapter",
  "consumes": [
    "application/json"
  ],
  "models": {
    "Alarm3rdEventDataVO": {
      "description": "",
      "id": "Alarm3rdEventDataVO",
      "properties": {
        "id": {
          "description": "告警ID",
          "required": false,
          "type": "string"
        },
        "source": {
          "description": "告警来源",
          "required": false,
          "type": "string"
        },
        "firstTime": {
          "description": "告警产生时间",
          "required": false,
          "type": "string"
        },
        "resName": {
          "description": "资源名称",
          "required": false,
          "type": "string"
        },
        "eventState": {
          "description": "告警状态，(-1:未恢复，1：恢复)",
          "required": false,
          "type": "string"
        },
        "eventType": {
          "description": "告警类型,(AVAIL_EVENT：可用性告警，PERF_EVENT：性能预警，CONF_EVENT:配置预警)",
          "required": false,
          "type": "string"
        },
        "resTypeName": {
          "description": "资源类型名称",
          "required": false,
          "type": "string"
        },
        "instId": {
          "description": "主资源ID",
          "required": false,
          "type": "string"
        },
        "treeNodeId": {
          "description": "tree节点ID，如：base为00；host为00.01，AIX就是00.01.01 如果是此模板为子资源模板，此列为空",
          "required": false,
          "type": "string"
        },
        "subInstId": {
          "description": "子资源ID",
          "required": false,
          "type": "string"
        },
        "resTypeId": {
          "description": "资源类型ID",
          "required": false,
          "type": "string"
        },
        "metricId": {
          "description": "指标ID",
          "required": false,
          "type": "string"
        },
        "eventName": {
          "description": "告警名称",
          "required": false,
          "type": "string"
        },
        "recoverTime": {
          "description": "告警恢复时间",
          "required": false,
          "type": "string"
        },
        "mainTreeNodeId": {
          "description": "告警对应资源所属的主资源的tree节点Id, 如果告警对应的资源是主资源,就放它自己的节点Id",
          "required": false,
          "type": "string"
        },
        "eventTypeName": {
          "description": "告警类型名称,(AVAIL_EVENT：可用性告警，PERF_EVENT：性能预警，CONF_EVENT:配置预警)",
          "required": false,
          "type": "string"
        },
        "eventLevelName": {
          "description": "告警级别名称，(1：信息，2：未知，3：警告，4：次要，5：主要，6：严重)",
          "required": false,
          "type": "string"
        },
        "recoverEventId": {
          "description": "恢复的告警ID",
          "required": false,
          "type": "string"
        },
        "eventLevel": {
          "description": "告警级别，(1：信息，2：未知，3：警告，4：次要，5：主要，6：严重)",
          "required": false,
          "type": "string"
        },
        "resIp": {
          "description": "资源IP",
          "required": false,
          "type": "string"
        },
        "eventMsg": {
          "description": "告警信息内容",
          "required": false,
          "type": "string"
        },
        "recovered": {
          "description": "记录告警是否恢复，(0:未恢复，1：恢复)",
          "required": false,
          "type": "string"
        },
        "resIpV6": {
          "description": "ipv6地址",
          "required": false,
          "type": "string"
        }
      }
    },
    "第三方获取事件列表": {
      "description": "",
      "id": "第三方获取事件列表",
      "properties": {
        "eventDatas": {
          "items": {
            "type": "Alarm3rdEventDataVO"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "EventVO": {
      "description": "",
      "id": "EventVO",
      "properties": {
        "name": {
          "description": "事件名称",
          "required": false,
          "type": "string"
        },
        "time": {
          "description": "事件产生时间, 长整型，毫秒数",
          "required": false,
          "format": "int64",
          "type": "integer"
        },
        "level": {
          "description": "事件级别",
          "required": false,
          "type": "string"
        },
        "resName": {
          "description": "资源名称",
          "required": false,
          "type": "string"
        },
        "viewType": {
          "description": "未受理：unaccepted_event_view已受理：accepted_event_view",
          "required": false,
          "type": "string"
        },
        "eventState": {
          "description": "事件状态",
          "required": false,
          "type": "string"
        },
        "eventType": {
          "description": "事件类型（AVAIL_EVENT(可用性事件)CONF_EVENT(配置事件)PERF_EVENT(性能事件)）",
          "required": false,
          "type": "string"
        },
        "resTempId": {
          "description": "模板ID",
          "required": false,
          "type": "string"
        },
        "eventId": {
          "description": "事件ID",
          "required": false,
          "type": "string"
        },
        "resType": {
          "description": "资源类型",
          "required": false,
          "type": "string"
        },
        "ip": {
          "description": "IP",
          "required": false,
          "type": "string"
        },
        "policyId": {
          "description": "策略ID",
          "required": false,
          "type": "string"
        },
        "metricId": {
          "description": "指标ID",
          "required": false,
          "type": "string"
        },
        "metricName": {
          "description": "指标名称",
          "required": false,
          "type": "string"
        },
        "resId": {
          "description": "资源ID",
          "required": false,
          "type": "string"
        },
        "collectType": {
          "description": "采集类型",
          "required": false,
          "type": "string"
        },
        "isApp": {
          "description": "是否为基础应用（1:是基础应用，0:非基础应用）",
          "required": false,
          "type": "string"
        },
        "createTime": {
          "description": "产生时间",
          "required": false,
          "type": "string"
        },
        "subResId": {
          "description": "子资源ID",
          "required": false,
          "type": "string"
        },
        "recovered": {
          "description": "recovered",
          "required": false,
          "type": "string"
        },
        "showAccept": {
          "required": false,
          "type": "boolean"
        },
        "showMaintain": {
          "required": false,
          "type": "boolean"
        },
        "recoveredEventId": {
          "description": "事件ID",
          "required": false,
          "type": "string"
        }
      }
    },
    "获取事件列表查询对象": {
      "description": "",
      "id": "获取事件列表查询对象",
      "properties": {
        "viewType": {
          "description": "查询事件类型(未受理：unaccepted_event_view 已受理：accepted_event_view)",
          "required": true,
          "type": "string"
        },
        "domainId": {
          "description": "域ID,可通过/login接口获得",
          "required": false,
          "type": "string"
        },
        "eventName": {
          "description": "事件名称",
          "required": false,
          "type": "string"
        },
        "resType": {
          "description": "资源类型",
          "required": false,
          "type": "string"
        },
        "resIp": {
          "description": "资源IP地址",
          "required": false,
          "type": "string"
        },
        "resName": {
          "description": "资源名称",
          "required": false,
          "type": "string"
        },
        "relRecoveredEvent": {
          "description": "是否显示未受理但已恢复的告警，默认false",
          "required": false,
          "type": "string"
        },
        "level": {
          "description": "事件级别，默认全部(1：信息，2：未知，3：警告，4：次要，5：主要，6：严重)",
          "required": false,
          "type": "string"
        },
        "isPageing": {
          "description": "是否分页，默认不分页(0：不分页，1：分页)",
          "required": false,
          "type": "string"
        },
        "pageIndex": {
          "description": "列表分页的请求页数，默认1",
          "required": false,
          "type": "string"
        },
        "ipOrResName": {
          "description": "IP或者是资源名称",
          "required": false,
          "type": "string"
        },
        "eventTypes": {
          "description": "事件类型",
          "required": false,
          "type": "string"
        },
        "resRange": {
          "required": false,
          "type": "string"
        },
        "sortColumn": {
          "description": "选填，排序字段值,只支持一个排序sortColumn和sortType 必须同时不为空才生效字段",
          "required": false,
          "type": "string"
        },
        "sortType": {
          "description": "选填，排序字段值,只支持一个排序sortColumn和sortType 必须同时不为空才生效字段，无默认值",
          "required": false,
          "type": "string"
        },
        "mainTreeNodeId": {
          "description": "事件对应资源所属的主资源的treenodeid, 如果事件对应的资源是主资源,就放他自己的",
          "required": false,
          "type": "string"
        },
        "treeNodeId": {
          "description": "tree节点ID，如：base为00；host为00.01，AIX就是00.01.01 如果是此模板为子资源模板，此列为空",
          "required": false,
          "type": "string"
        },
        "pageSize": {
          "description": "列表分页中每页条数，可不传，默认20",
          "required": false,
          "type": "string"
        },
        "eventTimeType": {
          "required": false,
          "type": "string"
        },
        "eventTimeStart": {
          "description": "告警首次发生时间",
          "required": false,
          "type": "string"
        },
        "eventTimeEnd": {
          "description": "告警结束时间",
          "required": false,
          "type": "string"
        }
      }
    },
    "获取登录信息": {
      "description": "",
      "id": "获取登录信息",
      "properties": {
        "_openCLIENT": {
          "description": "_openCLIENT 默认值是RIIL",
          "required": true,
          "type": "string"
        }
      }
    },
    "事件列表数据": {
      "description": "",
      "id": "事件列表数据",
      "properties": {
        "eventCount": {
          "items": {
            "type": "Entry«string,int»"
          },
          "required": false,
          "type": "array"
        },
        "totalCount": {
          "required": false,
          "format": "int32",
          "type": "integer"
        },
        "totalPage": {
          "description": "总页数(分页显示时使用)",
          "required": false,
          "format": "int32",
          "type": "integer"
        },
        "eventList": {
          "description": "EventVO对象集合",
          "items": {
            "type": "EventVO"
          },
          "required": false,
          "type": "array"
        },
        "pageIndex": {
          "description": "当前显示页(分页显示时使用)",
          "required": false,
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "Entry«string,int»": {
      "description": "",
      "id": "Entry«string,int»",
      "properties": {
        "key": {
          "required": false,
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "Void": {
      "description": "",
      "id": "Void",
      "properties": {}
    },
    "日志事件列表数据": {
      "description": "",
      "id": "日志事件列表数据",
      "properties": {
        "logEventList": {
          "description": "LogSummaryEventAlarmPojo 对象集合",
          "items": {
            "type": "LogSummaryEventAlarmVo"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "日志事件列表的查询对象": {
      "description": "",
      "id": "日志事件列表的查询对象",
      "properties": {
        "isPageing": {
          "description": "是否分页，默认不分页",
          "required": false,
          "type": "string"
        },
        "pageSize": {
          "description": "列表分页中每页条数，可不传，默认20",
          "required": false,
          "type": "string"
        },
        "pageIndex": {
          "description": "列表分页的请求页数，默认1",
          "required": false,
          "type": "string"
        },
        "plugId": {
          "description": "日志类型（Window：logmonitor-plugin-windows Syslog：logmonitor-plugin-syslog）",
          "required": false,
          "type": "string"
        },
        "alarmLevels": {
          "description": "告警级别，可穿多个以“，”分割(严重：CRITICAL 主要： MAJOR 次要： MINOR 警告： WARNING 信息： CLEARED)",
          "required": false,
          "type": "string"
        },
        "alarmsModeContext": {
          "description": "IP地址",
          "required": false,
          "type": "string"
        }
      }
    },
    "LogSummaryEventAlarmVo": {
      "description": "",
      "id": "LogSummaryEventAlarmVo",
      "properties": {
        "logType": {
          "description": "日志类型",
          "required": false,
          "type": "string"
        },
        "alarmLevel": {
          "description": "告警级别",
          "required": false,
          "type": "string"
        },
        "receiver": {
          "description": "接收人",
          "required": false,
          "type": "string"
        },
        "resourceName": {
          "description": "资源名称",
          "required": false,
          "type": "string"
        },
        "sendType": {
          "description": "消息类型",
          "required": false,
          "type": "string"
        },
        "sendTime": {
          "description": "发送时间",
          "required": false,
          "type": "string"
        },
        "alarmContent": {
          "description": "告警内容",
          "required": false,
          "type": "string"
        },
        "sendResult": {
          "description": "发送结果",
          "required": false,
          "type": "string"
        },
        "alarmsId": {
          "description": "事件ID",
          "required": false,
          "type": "string"
        },
        "logHost": {
          "description": "日志主机",
          "required": false,
          "type": "string"
        },
        "name": {
          "required": false,
          "type": "string"
        },
        "id": {
          "required": false,
          "type": "string"
        },
        "companyId": {
          "required": false,
          "type": "string"
        },
        "tag1": {
          "required": false,
          "type": "string"
        },
        "tag2": {
          "required": false,
          "type": "string"
        },
        "tag3": {
          "required": false,
          "type": "string"
        },
        "tag4": {
          "required": false,
          "type": "string"
        },
        "endIndex": {
          "required": false,
          "format": "int32",
          "type": "integer"
        },
        "pageCountSqlId": {
          "required": false,
          "type": "string"
        },
        "pageSqlId": {
          "required": false,
          "type": "string"
        },
        "pageSize": {
          "required": false,
          "format": "int32",
          "type": "integer"
        },
        "sortColumn": {
          "items": {
            "type": "string"
          },
          "required": false,
          "type": "array"
        },
        "customParamers": {
          "required": false,
          "type": "object"
        },
        "pageIndex": {
          "required": false,
          "format": "int32",
          "type": "integer"
        },
        "sortType": {
          "enum": [
            "ASC",
            "DESC"
          ],
          "required": false,
          "type": "string"
        },
        "orderBy": {
          "required": false,
          "type": "string"
        },
        "startIndex": {
          "required": false,
          "format": "int32",
          "type": "integer"
        }
      }
    }
  },
  "produces": [
    "*/*"
  ],
  "resourcePath": "/event/client",
  "swaggerVersion": "1.2"
}