跳到主要内容

get_alarm_email 获取告警邮件配置

POST /api/v1/alarm/get_alarm_email​

描述​

获取告警邮件配置接口，用于获取X86设备的告警邮件配置信息。

访问权限​

具备以下权限：

alarm:get_alarm_email

JSON参数​

请求参数如下：

{}

没有请求参数时候，需要传递一个空的JSON对象

响应结果​

请求返回的HTTP状态码为200

{
  "success": true|false,
  "data"?: {
    "emailAlertEnabled": true|false,
    "senderEmail": "option string",
    "senderName": "option string",
    "recipientEmails": [
      "option string"
    ],
    "alertLevel": "event" | "minor" | "major" | "critical",
    "includeDeviceId": true|false,
    "smtpServer": "option string",
    "smtpPort": 0,
    "smtpTimeout": 0,
    "smtpUseTLS": true|false,
    "smtpUseAuth": true|false,
    "smtpUsername": "option string",
    "smtpPassword": "option string",
    "emailSubjectPrefix": "option string",
    "checkInterval": 0,
    "maxEmailsPerHour": 0,
    "retryCount": 0,
    "retryDelay": 0
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
提示
  • emailAlertEnabled: 邮件告警功能总开关：true=启用，false=禁用
  • senderEmail: 发件人邮箱地址（必须与SMTP服务器匹配）
  • senderName: 发件人显示名称（显示在邮件中）
  • recipientEmails: 收件人邮箱列表（支持多个收件人）
  • alertLevel: 最低告警级别，取值范围为"event" | "minor" | "major" | "critical"
    • "event": 事件级别
    • "minor": 次要级别
    • "major": 主要级别
    • "critical": 严重级别
  • includeDeviceId: 是否在邮件中显示设备ID：true=显示，false=隐藏
  • smtpServer: SMTP服务器地址（例如：smtp.qq.com）
  • smtpPort: SMTP端口，常用端口包括：
    • 587: 使用STARTTLS加密
    • 465: 使用SSL加密
    • 25: 无加密
  • smtpTimeout: SMTP连接超时时间（秒）
  • smtpUseTLS: 是否使用TLS加密：true=加密，false=明文
  • smtpUseAuth: 是否需要认证：true=需要，false=匿名
  • smtpUsername: SMTP用户名（通常与发件人邮箱相同）
  • smtpPassword: SMTP密码（某些邮箱需使用授权码）
  • emailSubjectPrefix: 邮件主题前缀（用于标识告警邮件）
  • checkInterval: 检查告警文件间隔时间（秒）
  • maxEmailsPerHour: 每小时最大邮件发送数量（防止轰炸）
  • retryCount: 发送失败重试次数
  • retryDelay: 重试间隔时间（秒）

正确结果示例：

{
  "success": true,
  "data":{
    "emailAlertEnabled": true,
    "senderEmail": "280089088@qq.com",
    "senderName": "CTS Alert",
    "recipientEmails": [
      "jiangguiliang94@sina.com",
      "280089088@qq.com", 
    ],
    "alertLevel": "minor",
    "includeDeviceId": true,
    "smtpServer": "smtp.qq.com",
    "smtpPort": 587,
    "smtpTimeout": 30,
    "smtpUseTLS": true,
    "smtpUseAuth": true,
    "smtpUsername": "280089088@qq.com",
    "smtpPassword": "iccldoyzszunbhfj",
    "emailSubjectPrefix": "[CTS Alert]",
    "checkInterval": 10,
    "maxEmailsPerHour": 20,
    "retryCount": 3,
    "retryDelay": 5
  },
}

错误结果示例：

{
  "success": false,
  "errorCode": "40000",
  "errorMessage": "no.blank.params",
  "showType": 4
}