跳转到主要内容
告警与响应相关接口/告警模板

渲染告警模板

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

POST/api/v1/alerting/templates/render

操作 ID

RenderAlertTemplate

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • content
    String必填

    模板内容渲染。

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

  • format
    String必填

    数据格式或导出格式。

    示例: markdown

  • payload
    String必填

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

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

响应状态

200 OK
200 OK

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

  • output
    String

    已渲染模板输出。

    示例: # Alert: High CPU

  • error
    String

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

    示例: connection refused