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

渲染告警模板

渲染模板样例数据预览输出。

调试可用性

在线调试

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

请求参数

请求体字段

  • contentString必填

    模板内容渲染。

    示例： # Alert: {{.AlertName}}

  • formatString必填

    数据格式或导出格式。

    示例： markdown

  • payloadString必填

    JSON负载数据模板变量替换。

    示例： {"AlertName": "High CPU"}

响应状态

200 OK

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

  • outputString

    已渲染模板输出。

    示例： # Alert: High CPU

  • errorString

    错误码。操作成功时为 null，失败时返回具体错误信息。

    示例： connection refused

请求地址

POST/api/v1/alerting/templates/render

/api/v1/alerting/templates/render

操作 ID

RenderAlertTemplate

永久链接

请求示例

curl -X POST '{host}/api/v1/alerting/templates/render' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"content":"# Alert: {{.AlertName}}","format":"markdown","payload":"{\"AlertName\": \"High CPU\"}"}'

响应示例

200
{
  "output": "# Alert: High CPU",
  "error": "connection refused"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史