跳转到主要内容
API Explorer|API Explorer
告警与响应相关接口/告警通道与集成
POSTAlerting起始版本 1.0同步需要认证

测试发送告警通知

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • channelIdString必填

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

请求体字段

  • templateIdString必填

    模板ID。

    示例： tmpl-email-001

响应状态

200 OK

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

  • successBoolean

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

    示例： true

  • errorMessageString

    错误返回消息。

    示例： authentication failed

  • renderedPreviewString

    已渲染内容预览模板。

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

请求地址

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

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

操作 ID

TestSendAlertNotification

永久链接

请求示例

curl -X POST '{host}/api/v1/alerting/channels/{channelId}/test-send' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"templateId":"tmpl-email-001"}'

响应示例

200
{
  "success": true,
  "errorMessage": "authentication failed",
  "renderedPreview": "<h1>Alert: High CPU</h1>"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史