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

测试发送告警通知

发送测试通知可选模板渲染预览固定RI PT NI 03统一测试发送可选模板。

POST/api/v1/alerting/channels/{channelId}/test-send

操作 ID

TestSendAlertNotification

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • channelId
    String必填

    渠道标识符发送测试通知。

请求体字段

  • templateId
    String必填

    模板ID。

    示例： tmpl-email-001

响应状态

200 OK
200 OK

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

  • success
    Boolean

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

    示例： true

  • errorMessage
    String

    错误返回消息。

    示例： authentication failed

  • renderedPreview
    String

    已渲染内容预览模板。

    示例： <h1>Alert: High CPU</h1>