跳转到主要内容
POST
Error

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
threshold
number
必填

Threshold value for triggering the alert. For between and not_between threshold types, this is the lower bound.

示例:

100

interval
enum<string>
必填

Evaluation interval for the alert.

可用选项:
1m,
5m,
15m,
30m,
1h,
6h,
12h,
1d
示例:

"1h"

thresholdType
enum<string>
必填

Threshold comparison direction.

可用选项:
above,
below,
above_exclusive,
below_or_equal,
equal,
not_equal,
between,
not_between
示例:

"above"

channel
object
必填

Alert notification channel configuration.

dashboardId
string | null

Dashboard ID for tile-based alerts.

示例:

"65f5e4a3b9e77c001a567890"

tileId
string | null

Tile ID for tile-based alerts. Must be a line, stacked bar, or number type tile.

示例:

"65f5e4a3b9e77c001a901234"

savedSearchId
string | null

Saved search ID for saved_search alerts.

示例:

"65f5e4a3b9e77c001a345678"

groupBy
string | null

Group-by key for saved search alerts.

示例:

"ServiceName"

thresholdMax
number | null

Upper bound for between and not_between threshold types. Required when thresholdType is between or not_between, must be >= threshold.

示例:

500

scheduleOffsetMinutes
integer | null

Offset from the interval boundary in minutes. For example, 2 with a 5m interval evaluates windows at :02, :07, :12, etc. (UTC).

必填范围: x >= 0
示例:

2

scheduleStartAt
string<date-time> | null

Absolute UTC start time anchor. Alert windows start from this timestamp and repeat every interval.

示例:

"2026-02-08T10:00:00.000Z"

source
enum<string>

Alert source type (tile-based or saved search).

可用选项:
saved_search,
tile
示例:

"tile"

name
string | null

Human-friendly alert name.

示例:

"Test Alert"

message
string | null

Alert message template.

示例:

"Test Alert Message"

note
string | null

Freeform note for the alert. Supports markdown formatting.

Required string length: 1 - 4096
示例:

"Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook)."

numConsecutiveWindows
integer | null

Fire the alert only after its condition has been met for this many consecutive evaluation windows. While the condition is met but fewer than this many consecutive windows have violated, the alert is in the PENDING state.

必填范围: x >= 1
示例:

3

响应

Successfully created alert

data
object

The alert object.

最后修改于 2026年7月15日