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

测试告警SMTP配置

测试SMTP连通性保存配置固定RI NI 01独立SMTP连通性测试。

POST/api/v1/alerting/channels/smtp/test

操作 ID

TestAlertSmtpConfig

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • host
    String必填

    主机地址。

    示例： smtp.example.com

  • port
    Integer必填

    端口号。

    示例： 587

  • username
    String必填

    用户名。

    示例： alerts@example.com

  • password
    String必填

    密码。

    示例： secret

  • encryption
    String必填

    模式无SSL starttls。

    示例： starttls

响应状态

200 OK
200 OK

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

  • success
    Boolean

    操作是否成功。true 表示成功，false 表示失败。

    示例： true

  • errorMessage
    String

    错误返回消息。

    示例： authentication failed