告警 API

1. "获取告警列表"

  1. route definition
  • Url: /api/v1/alerts
  • Method: GET
  • Request: AlertsListRequest
  • Response: AlertsListResponse
  1. request definition
type AlertsListRequest struct {
	Page int `form:"page,optional,default=1"`
	PageSize int `form:"pageSize,optional,default=20"`
	Level string `form:"level,optional"`
	Status string `form:"status,optional"`
}
  1. response definition
type AlertsListResponse struct {
	Items []Alert `json:"items"`
	Total int64 `json:"total"`
	Page int `json:"page"`
	Size int `json:"pageSize"`
}

2. "静默告警"

  1. route definition
  • Url: /api/v1/alerts/:id/silence
  • Method: POST
  • Request: AlertSilenceRequest
  • Response: -
  1. request definition
type AlertSilenceRequest struct {
	ID string `path:"id"`
	Duration int `json:"duration"` // 分钟
	Reason string `json:"reason,optional"`
}
  1. response definition

3. "获取静默规则列表"

  1. route definition
  • Url: /api/v1/alerts/silences
  • Method: GET
  • Request: SilencesListRequest
  • Response: SilencesListResponse
  1. request definition
type SilencesListRequest struct {
}
  1. response definition
type SilencesListResponse struct {
	Items []Silence `json:"items"`
}

4. "删除静默规则"

  1. route definition
  • Url: /api/v1/alerts/silences/:id
  • Method: DELETE
  • Request: SilenceDeleteRequest
  • Response: -
  1. request definition
type SilenceDeleteRequest struct {
	ID string `path:"id"`
}
  1. response definition