수정 (해당 인터페이스는 2025-12-30에 폐기되었으며, v2 인터페이스 사용을 권장합니다)¶
POST /api/v1/alert_policy/{alert_policy_uuid}/modify
개요¶
alert_policy_uuid를 기준으로 지정된 알림 정책 구성을 수정합니다.
라우트 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| alert_policy_uuid | string | Y | 알림 정책 UUID |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | 모니터 이름 빈 값 허용: False |
|
| desc | string | 설명 빈 값 허용: False 빈 문자열 허용: True 최대 길이: 256 |
|
| openPermissionSet | boolean | 사용자 정의 권한 구성 활성화 (기본값 false: 비활성화), 활성화 시 해당 규칙의 작업 권한은 permissionSet에 따름 빈 값 허용: False |
|
| permissionSet | array | 작업 권한 구성, 구성 가능 항목 (역할(소유자 제외), 멤버 UUID, 팀 UUID) 예시: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] 빈 값 허용: False |
|
| ruleTimezone | str | Y | 알림 정책 시간대 예시: Asia/Shanghai 빈 값 허용: False |
| alertOpt | json | 알림 설정 빈 값 허용: False |
|
| alertOpt.alertType | string | 알림 정책 알림 유형, 등급(status)/멤버(member), 기본값은 등급 빈 값 허용: False 可选值: ['status', 'member'] |
|
| alertOpt.silentTimeout | integer | 반복 알림 구성 빈 값 허용: False |
|
| alertOpt.silentTimeoutByStatusEnable | boolean | 등급별 반복 알림 설정 활성화 여부, 기본값 false, silentTimeout 사용 빈 값 허용: False |
|
| alertOpt.silentTimeoutByStatus | array | 등급별 반복 알림 설정, 등급별 최소 알림 간격 구성 빈 값 허용: False |
|
| alertOpt.alertTarget | array | 트리거 동작, 트리거 시간 및 파라미터 처리에 유의 예시: [{'name': '알림 구성1', 'targets': [{'to': ['acnt_xxxx32'], 'status': 'critical', 'tags': {'pod_name': ['coredns-7769b554cf-w95fk']}, 'upgradeTargets': [{'to': ['acnt_xxxx32'], 'duration': 600}, {'to': ['group_xxxx32'], 'duration': 6000}]}], 'crontabDuration': 600, 'crontab': '0 9 * * 0,1,2,3,4'}, {'name': '알림 구성2', 'targets': [{'status': 'error', 'to': ['group_xxxx32'], 'upgradeTargets': [{'to': ['acnt_xxxx32'], 'duration': 600}, {'to': ['group_xxxx32'], 'duration': 6000}]}], 'customDateUUIDs': ['ndate_xxxx32'], 'customStartTime': '09:30:10', 'crontabDuration': 600}] 빈 값 허용: False |
|
| alertOpt.aggInterval | integer | Y | 알림 집계 간격, 단위 초, 0은 집계하지 않음 빈 값 허용: False $minValue: 0 $maxValue: 1800 |
| alertOpt.aggFields | array | 집계 필드 목록, 빈 목록[]은 '집계 규칙: 전체'를 의미, df_monitor_checker_id：모니터/지능형 점검/SLO, df_dimension_tags：탐지 차원, df_label：태그, CLUSTER：지능형 집계 예시: ['CLUSTER'] 빈 값 허용: False |
|
| alertOpt.aggLabels | array | 태그별 집계 시 태그 값 목록, aggFields에 df_label이 지정된 경우에만 적용 빈 값 허용: False |
|
| alertOpt.aggClusterFields | array | 지능형 집계 시 필드 목록, aggFields에 CLUSTER가 지정된 경우에만 적용, 선택 가능 값 "df_title"：제목, "df_message"：내용 예시: ['df_title'] 빈 값 허용: False |
파라미터 추가 설명¶
요청 예시¶
curl 'https://openapi.guance.com/api/v1/alert_policy/altpl_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"jj_modify","ruleTimezone":"Asia/Shanghai","alertOpt":{"alertTarget":[{"targets":[{"status":"warning","to":["notify_xxxx32"]}]}],"silentTimeout":21600,"aggInterval":120,"aggFields":["df_monitor_checker_id"]}}' \
--compressed
응답¶
{
"code": 200,
"content": {
"alertOpt": {
"aggFields": [
"df_monitor_checker_id"
],
"aggInterval": 120,
"alertTarget": [
{
"targets": [
{
"status": "warning",
"to": [
"notify_xxxx32"
]
}
]
}
],
"silentTimeout": 21600
},
"createAt": 1706152082,
"creator": "xxxx",
"declaration": {},
"deleteAt": -1,
"id": 4100,
"name": "jj_modify",
"ruleTimezone": "Asia/Shanghai",
"score": 0,
"status": 0,
"updateAt": 1706152339.7920609,
"updator": "xxx",
"uuid": "altpl_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-D38C6668-6F44-45E8-B8A4-BD28EBF142DE"
}