跳转到主要内容
ZStack
告警与响应相关接口/告警通道与集成

保存告警SMTP配置

保存更新全局SMTP配置邮箱通知。

PUT/api/v1/alerting/smtp-config

操作 ID

SaveAlertSmtpConfig

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • host
    String

    主机地址。

    示例： smtp.example.com

  • port
    Integer

    端口号。

    示例： 587

  • encryption
    String

    模式无SSL starttls。

    示例： starttls

  • username
    String

    用户名。

    示例： alerts@example.com

  • password
    String

    密码。

    示例： secret

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • host
    String

    主机地址。

    示例： smtp.example.com

  • port
    Integer

    端口号。

    示例： 587

  • encryption
    String

    模式无SSL starttls。

    示例： starttls

  • username
    String

    用户名。

    示例： alerts@example.com

  • fromAddr
    String

    发送者邮箱地址。

    示例： alerts@example.com

  • fromName
    String

    发送者显示名称。

    示例： ZCF Alerts

  • createDate
    String

    创建时间。

    示例： 2026-01-15T08:00:00Z

  • lastOpDate
    String

    最近一次操作时间。

    示例： 2026-01-15T08:00:00Z

  • authMethod
    String

    认证方式：`none`、`plain` 或 `oauth2`（`XOAUTH2`）。

    示例： oauth2

变更历史

查看全部变更历史

  • 变更时间

    新增请求体字段 accessToken, authMethod新增响应字段 authMethod
    查看 API