경고 규칙 API

엔드포인트: /api/metrics/alert-rules/

경고 규칙은 에이전트가 이미 보낸 데이터를 사용해 서버의 지표를 감시하다가 값이 설정한 방향으로 임계값을 지나면 경고를 발생시킵니다. 규칙은 Alpacon이 자체 일정에 따라 약 1분마다 평가합니다. 규칙이 발생하고 해제되는 방식은 모니터링 규칙을 참고하세요.

기본으로 생성되는 디스크 사용률 규칙(모든 서버가 플랜과 관계없이 갖는 규칙)을 포함해, 모든 동작에 워크스페이스의 Metrics 확장 기능이 켜져 있어야 합니다.

경고 규칙 목록 조회

경고 규칙 목록을 페이지네이션하여 가져옵니다.

GET /api/metrics/alert-rules/

쿼리 파라미터

응답

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "3f1c9b2e-6a4d-4e8f-9b1a-2c3d4e5f6a7b",
      "owner": null,
      "name": "Core disk usage",
      "target": "disk-usage",
      "threshold": 90,
      "operator": "gte",
      "duration_s": 0,
      "recovery_threshold": 85,
      "no_data_after_s": null,
      "device": "",
      "severity": "warning",
      "is_default": true
    },
    {
      "id": "8c4d6e2a-1b3f-4a5c-8d9e-0f1a2b3c4d5e",
      "owner": {
        "id": 1,
        "name": "admin",
        "email": "admin@example.com"
      },
      "name": "Sustained high CPU",
      "target": "cpu-usage",
      "threshold": 80,
      "operator": "gte",
      "duration_s": 300,
      "recovery_threshold": 70,
      "no_data_after_s": 600,
      "device": "",
      "severity": "critical",
      "is_default": false
    }
  ]
}

필요한 스코프: alert_rule:read

예시

curl -X GET "https://your-workspace.ap1.alpacon.io/api/metrics/alert-rules/?target=cpu-usage" \
  -H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\""

경고 규칙 생성

새 경고 규칙을 만듭니다.

POST /api/metrics/alert-rules/

요청 본문

{
  "name": "Sustained high CPU",
  "target": "cpu-usage",
  "threshold": 80,
  "operator": "gte",
  "duration_s": 300,
  "recovery_threshold": 70,
  "no_data_after_s": 600,
  "severity": "critical"
}

요청 파라미터

응답

{
  "id": "8c4d6e2a-1b3f-4a5c-8d9e-0f1a2b3c4d5e",
  "owner": {
    "id": 1,
    "name": "admin",
    "email": "admin@example.com"
  },
  "name": "Sustained high CPU",
  "target": "cpu-usage",
  "threshold": 80,
  "operator": "gte",
  "duration_s": 300,
  "recovery_threshold": 70,
  "no_data_after_s": 600,
  "device": "",
  "severity": "critical",
  "is_default": false
}

필요한 스코프: alert_rule:create

예시

curl -X POST "https://your-workspace.ap1.alpacon.io/api/metrics/alert-rules/" \
  -H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\"" \
  -H "Content-Type: application/json" \
  -d '{"name": "Sustained high CPU", "target": "cpu-usage", "threshold": 80, "duration_s": 300}'

경고 규칙 상세 조회

특정 경고 규칙을 ID로 조회합니다.

GET /api/metrics/alert-rules/{rule_id}/

경로 파라미터

응답

{
  "id": "8c4d6e2a-1b3f-4a5c-8d9e-0f1a2b3c4d5e",
  "owner": {
    "id": 1,
    "name": "admin",
    "email": "admin@example.com"
  },
  "name": "Sustained high CPU",
  "target": "cpu-usage",
  "threshold": 80,
  "operator": "gte",
  "duration_s": 300,
  "recovery_threshold": 70,
  "no_data_after_s": 600,
  "device": "",
  "severity": "critical",
  "is_default": false
}

필요한 스코프: alert_rule:read

예시

curl -X GET "https://your-workspace.ap1.alpacon.io/api/metrics/alert-rules/8c4d6e2a-1b3f-4a5c-8d9e-0f1a2b3c4d5e/" \
  -H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\""

경고 규칙 수정

기존 경고 규칙을 수정합니다. PATCH를 통한 부분 업데이트를 지원합니다.

PATCH /api/metrics/alert-rules/{rule_id}/

경로 파라미터

요청 본문

{
  "threshold": 85,
  "recovery_threshold": 75
}

요청 파라미터

경고 규칙 생성과 같은 필드이며, 모두 선택 사항입니다. operator나 threshold를 바꾸면 이 규칙 자체의 복귀 임계값이나 서버 오버라이드의 복귀 임계값이 바뀐 값의 잘못된 쪽에 남게 될 경우, 그 수정은 거부됩니다.

응답

수정된 필드를 포함한 전체 경고 규칙 객체를 반환합니다 (경고 규칙 상세 조회와 같은 스키마).

필요한 스코프: alert_rule:update

예시

curl -X PATCH "https://your-workspace.ap1.alpacon.io/api/metrics/alert-rules/8c4d6e2a-1b3f-4a5c-8d9e-0f1a2b3c4d5e/" \
  -H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\"" \
  -H "Content-Type: application/json" \
  -d '{"threshold": 85, "recovery_threshold": 75}'

경고 규칙 삭제

경고 규칙을 삭제합니다. 기본 규칙(is_default: true)은 기본 상태로 지정된 채로는 삭제할 수 없습니다. 먼저 is_default를 해제하세요.

DELETE /api/metrics/alert-rules/{rule_id}/

경로 파라미터

응답

204 No Content

필요한 스코프: alert_rule:delete

예시

curl -X DELETE "https://your-workspace.ap1.alpacon.io/api/metrics/alert-rules/8c4d6e2a-1b3f-4a5c-8d9e-0f1a2b3c4d5e/" \
  -H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\""

오류 코드