수정(이 API는 2025-12-30일에 지원이 종료되며, v2 버전 API 사용을 권장합니다)¶
POST /api/v1/alert_policy/{alert_policy_uuid}/modify
개요¶
알림 정책의 알림 구성과 작업 권한을 수정합니다.
호출 전 확인 및 사용 단계¶
먼저 상세 정보를 조회한 후 전체 대상 alertOpt로 교체합니다. alertOpt를 생략하면 기존 구성이 유지되고, {}를 전달하면 해당 객체가 비워집니다. 기존 name, 필수 ruleTimezone, 전체 alertOpt를 함께 제출하여 심층 검증을 트리거하는 것이 좋습니다. 순수 알림 구성 수정은 현재 코드에서 심층 검증을 건너뛸 수 있으므로, 성공이 곧 대상 구조가 반드시 실행 가능함을 의미하지는 않습니다. 이 v1 API는 알림 정책만 저장하며 모니터/SLO/보안 규칙 바인딩은 수정하지 않습니다. 바인딩을 조정하려면 v2를 사용하세요. 현재 버전에서는 최상위 ruleTimezone이 저장되고 표시되지만, 실행 캐시는 이전 alertOpt.ruleTimezone을 읽으며 기본값은 Asia/Shanghai입니다. 다른 시간대는 저장 성공만으로 적용되었다고 판단할 수 없으므로, 연동 측에서 실제 실행 시간대로 검증해야 합니다. 선언되지 않은 추가 필드로 공개 매개변수를 우회하지 마세요. 저장 및 캐시 새로고침은 알림 전달을 의미하지 않으며, 실제 전송은 유효한 대상, 이벤트 등급, 시간 구간, 필터, 중복 억제, 알림 실행 서비스에 따라 달라집니다. 실패 또는 타임아웃 후에는 먼저 정책 및 바인딩 상태를 조회하여 중복 생성이나 부분 업데이트 오판을 피하세요.
라우트 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| alert_policy_uuid | string | Y | 현재 워크스페이스 알림 정책 UUID입니다. 예시: altpl_example조회 또는 입력 방법: 알림 정책 목록의 content.data[].uuid에서 가져오며, 수정 전에 알림 정책 상세로 확인합니다. |
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>조회 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| permissionSet[*] | string | 단일 작업 가능 주체 식별자입니다. 적용 여부는 ID 및 리소스의 현재 상태에 따라 달라집니다. 예시: wsAdmin조회 또는 입력 방법: 역할 UUID(예: wsAdmin/general/readOnly/role_ ), acnt_ 계정 또는 group_ 팀을 사용합니다. 계정/팀은 이 워크스페이스의 실제 리소스를 기준으로 합니다. |
|
| alertOpt.silentTimeoutByStatus[*] | json | 등급별 간격 객체입니다. 예시: {"status": "critical,error", "silentTimeout": 600}조회 또는 입력 방법: 각 항목은 등급 그룹과 초 수를 정의합니다. |
|
| alertOpt.silentTimeoutByStatus[*].status | string | 비보안은 fatal/critical/error/warning/nodata/info/ALL을 사용할 수 있고, 보안은 security_critical/security_high/security_medium/security_low/security_info/security_ALL을 사용합니다. 여러 값은 영문 쉼표로 연결하며 공백을 넣지 않습니다. 예시: critical,error조회 또는 입력 방법: 이벤트 등급에서 선택하며, 보안 등급은 security_ 접두사를 사용합니다(예: security_high). |
|
| alertOpt.silentTimeoutByStatus[*].silentTimeout | integer | 각 그룹의 필수 반복 간격이며 단위는 초입니다. 잘못된 등급은 내부 오류를 유발할 수 있으므로 전송 전에 검증하세요. 예시: 600조회 또는 입력 방법: 해당 등급의 음수가 아닌 정수 초를 입력하며, 0은 더 이상 주기적으로 반복하지 않음을 의미합니다. |
|
| alertOpt.aggFields[*] | string | 단일 집계 필드입니다. byCustom은 실제 이벤트 필드를 기준으로 선택하며, 표시 이름만으로 필드를 추측하지 마세요. 예시: df_monitor_checker_id조회 또는 입력 방법: 이벤트 모니터는 df_monitor_checker_id, 탐지 차원은 df_dimension_tags, 태그는 df_label, 과거 지능형 집계는 CLUSTER를 사용합니다. |
|
| alertOpt.aggLabels[*] | string | 단일 태그 값입니다. 예시: production조회 또는 입력 방법: 실제 이벤트의 태그 값을 가져옵니다. |
|
| alertOpt.aggClusterFields[*] | string | 단일 텍스트 필드입니다. 예시: df_title조회 또는 입력 방법: 제목은 df_title, 내용은 df_message를 사용합니다. |
|
| alertOpt.alertTarget[*] | json | 규칙 객체입니다. 폴백이 필요하면 시간 구성이 없는 규칙을 명시적으로 추가하며, 시스템이 자동으로 보완한다고 가정하지 마세요. 예시: {"name": "默认通知", "targets": [{"status": "critical", "to": ["notify_example"]}]}조회 또는 입력 방법: 각 항목에 하나의 시간 창 또는 시간 제한이 없는 폴백 규칙을 구성합니다. |
|
| alertOpt.alertTarget[*].name | string | 선택적 규칙 이름이며 최대 256자입니다. 예시: 默认通知조회 또는 입력 방법: 비즈니스 용도에 따라 이름을 지정합니다. |
|
| alertOpt.alertTarget[*].crontab | string | 주기 시작 시간 표현식이며 crontabDuration과 쌍을 이뤄야 합니다. 사용자 지정 날짜 방식과 둘 중 하나를 선택합니다. 예시: 0 9 * * 1-5조회 또는 입력 방법: 반복 시작 시간에 따라 Cron 표현식을 입력합니다(예: 평일 9시). 동시에 crontabDuration을 제공해야 합니다. |
|
| alertOpt.alertTarget[*].crontabDuration | integer | 주기 창의 지속 시간(초)입니다. crontab을 제공할 때 반드시 함께 제공해야 하며, 반복 시간 구간을 구성하지 않으면 둘 다 생략합니다. 예시: 28800조회 또는 입력 방법: 시간 창 길이를 양의 정수 초로 환산합니다. 예를 들어 28800은 8시간입니다. |
|
| alertOpt.alertTarget[*].customDateUUIDs | array | 사용자 지정 날짜 집합 참조이며 최대 366개 항목입니다. customStartTime, customDuration과 함께 제공해야 하며 crontabDuration으로 대체할 수 없습니다. 예시: ["ndate_example"]조회 또는 입력 방법: 사용자 지정 알림 날짜의 content.data[].uuid에서 날짜 집합을 가져옵니다. 각 항목은 날짜 문자열이 아닌 날짜 구성 UUID입니다. |
|
| alertOpt.alertTarget[*].customDateUUIDs[*] | string | 단일 날짜 구성 UUID입니다. 예시: ndate_example조회 또는 입력 방법: 사용자 지정 알림 날짜에서 동일 워크스페이스의 유효한 날짜 구성 UUID를 복사합니다. |
|
| alertOpt.alertTarget[*].customStartTime | string | 사용자 지정 날짜 당일의 시작 시각이며 customDateUUIDs/customDuration과 함께 사용합니다. 예시: 09:30:00조회 또는 입력 방법: 선택한 날짜의 현지 시각 기준 HH:MM:SS로 입력하며, 실제 실행 시간대로 해석됩니다. |
|
| alertOpt.alertTarget[*].customDuration | integer | 사용자 지정 날짜 창의 지속 시간(초)이며 날짜 집합 및 시작 시각과 반드시 함께 제공해야 합니다. 예시: 3600조회 또는 입력 방법: 창 길이를 양의 정수 초로 입력합니다. 예를 들어 3600은 1시간입니다. |
|
| alertOpt.alertTarget[*].targets | array | status 모드 작업 배열입니다. 예시: [{"status": "critical", "to": ["notify_example"]}]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].targets[*] | json | 단일 등급 작업입니다. 예시: {"status": "critical", "to": ["notify_example"]}조회 또는 입력 방법: 각 이벤트 소스와 등급마다 하나의 작업을 설정합니다. |
|
| alertOpt.alertTarget[*].targets[*].status | string | 필수 등급 선택: fatal, critical, error, warning, nodata, info이며 전체는 대문자 ALL을 사용합니다. 여러 값은 영문 쉼표로 연결하고 공백을 넣지 않습니다. security 소스는 critical, high, medium, low, info 또는 ALL을 사용합니다. 예시: critical조회 또는 입력 방법: 실제 이벤트의 df_status를 사용하며, 보안 이벤트는 df_source=security도 설정합니다. |
|
| alertOpt.alertTarget[*].targets[*].df_source | string | 선택 사항이며, 공개 대상 구조는 security만 지원합니다. 생략하면 실행 계층에서 보안 소스를 제외합니다. 예시: security조회 또는 입력 방법: 보안 모니터링 이벤트에만 security를 입력하고 일반 이벤트에서는 생략합니다. |
|
| alertOpt.alertTarget[*].targets[*].to | array | 필수 수신 대상 배열이며 멤버, 팀, 알림 대상 또는 이메일을 사용할 수 있습니다. 에이전트 계정은 유효한 기본 Webhook을 사용할 수 있습니다. 예시: ["notify_example"]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].targets[*].to[*] | string | member 모드에서는 email/sms/notify_를 주로 사용하고, status 모드에서는 acnt_/agent_/group_/notify_ 또는 이메일을 사용합니다. SMS 등 채널의 사용 가능 여부는 사이트 및 대상 구성에 따라 달라집니다. 예시: notify_example조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].targets[*].tags | json | status 모드에서는 필드 값으로 이벤트를 필터링합니다. member 모드에서는 상위 alertInfo.filterString을 사용해야 하며, 여기의 tags는 멤버 선택 조건으로 사용되지 않습니다. 예시: {"env": ["production"]}조회 또는 입력 방법: 이벤트 원본 필드와 값으로 딕셔너리를 구성합니다. |
|
| alertOpt.alertTarget[*].targets[*].tags.字段 | array | 단일 필드의 매칭 값 배열입니다. 예시: ["production"]조회 또는 입력 방법: 키는 실제 이벤트 필드(예: env)를 사용하고, 값은 매칭할 실제 필드 값 배열을 사용합니다. |
|
| alertOpt.alertTarget[*].targets[*].tags.字段[*] | string | 단일 매칭 값입니다. 예시: production조회 또는 입력 방법: 이벤트의 동일한 필드에서 값을 가져옵니다. |
|
| alertOpt.alertTarget[*].targets[*].filterString | string | status 모드에서 값이 있으면 tags보다 우선하며 에스컬레이션 작업에도 사용됩니다. member 모드에서는 상위 alertInfo.filterString을 사용하며, 해당 대상 내 필드는 유효한 필터 진입점으로 사용되지 않습니다. 예시: env:production조회 또는 입력 방법: 서버 측 FilterString 문법을 사용합니다(예: env:production). 복잡한 조건은 콘솔에서 생성한 후 복사합니다. |
|
| alertOpt.alertTarget[*].targets[*].upgradeTargets | array | 선택적 에스컬레이션 작업입니다. 이벤트가 해당 등급으로 duration 동안 지속되면 실행되며, []는 에스컬레이션을 구성하지 않음을 의미합니다. 예시: [{"to": ["acnt_example"], "duration": 600}]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].targets[*].upgradeTargets[*] | json | 단일 에스컬레이션 작업입니다. 예시: {"to": ["acnt_example"], "duration": 600}조회 또는 입력 방법: 각 에스컬레이션마다 수신 대상과 대기 초를 선택합니다. |
|
| alertOpt.alertTarget[*].targets[*].upgradeTargets[*].to | array | member 모드에서는 에스컬레이션 수신 멤버/팀이고, status 모드에서는 에스컬레이션 알림 대상이며 멤버/팀/알림 대상/이메일을 사용할 수 있습니다. 예시: ["acnt_example"]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].targets[*].upgradeTargets[*].to[*] | string | 단일 에스컬레이션 수신 식별자입니다. 예시: acnt_example조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].targets[*].upgradeTargets[*].duration | integer | 필수 지속 시간(초)입니다. 각 에스컬레이션은 이벤트 지속 상태를 기준으로 구성하며 여러 duration을 자동으로 누적하지 않습니다. 예시: 600조회 또는 입력 방법: 비즈니스 요구에 따라 양의 정수 초를 입력합니다. 예를 들어 600은 해당 등급이 10분간 지속됨을 의미합니다. |
|
| alertOpt.alertTarget[*].targets[*].upgradeTargets[*].toWay | array | member 에스컬레이션 알림 방식 배열이며 status 모드에서는 이 필드를 사용하지 않습니다. 예시: ["email"]조회 또는 입력 방법: member 모드에서는 email/sms 또는 알림 대상 목록의 notify_ 객체 중에서 선택하고, status 모드에서는 생략합니다. |
|
| alertOpt.alertTarget[*].targets[*].upgradeTargets[*].toWay[*] | string | 단일 에스컬레이션 알림 방식입니다. 예시: email조회 또는 입력 방법: 실제 사용 가능한 email/sms 또는 알림 대상 UUID를 선택합니다. |
|
| alertOpt.alertTarget[*].alertInfo | array | member 모드에서만 사용하는 멤버 그룹 배열이며 status 모드에서는 사용하지 않습니다. 예시: [{"name": "生产负责人", "memberInfo": ["acnt_example"], "filterString": "env:production", "targets": [{"status": "critical", "to": ["email"]}]}]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*] | json | 멤버 그룹 객체입니다. 예시: {"name": "生产负责人", "memberInfo": ["acnt_example"], "targets": [{"status": "critical", "to": ["email"]}]}조회 또는 입력 방법: 각 그룹에 멤버 범위, 이벤트 조건, 알림 방식을 입력합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].name | string | 선택적 멤버 그룹 이름이며 최대 256자입니다. 예시: 生产负责人조회 또는 입력 방법: 멤버 그룹의 비즈니스 용도에 따라 이름을 지정합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].memberInfo | array | 멤버 모드 일반 알림의 수신 멤버/팀 배열이며 에이전트 계정을 포함할 수 있습니다. targets.to 알림 방식과 조합됩니다. 예시: ["acnt_example"]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].memberInfo[*] | string | 단일 멤버 또는 팀 식별자입니다. 예시: acnt_example조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].filterString | string | 멤버 그룹 수준 이벤트 필터이며 일반 및 에스컬레이션 작업 모두 이 조건을 사용합니다. 예시: env:production조회 또는 입력 방법: 실제 이벤트 필드로 구성합니다(예: env:production). |
|
| alertOpt.alertTarget[*].alertInfo[*].targets | array | 멤버 모드의 알림 방식/등급 작업 배열입니다. 예시: [{"status": "critical", "to": ["email"]}]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*] | json | 단일 등급 작업입니다. 예시: {"status": "critical", "to": ["email"]}조회 또는 입력 방법: 각 이벤트 소스와 등급마다 하나의 작업을 설정합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].status | string | 필수 등급 선택: fatal, critical, error, warning, nodata, info이며 전체는 대문자 ALL을 사용합니다. 여러 값은 영문 쉼표로 연결하고 공백을 넣지 않습니다. security 소스는 critical, high, medium, low, info 또는 ALL을 사용합니다. 예시: critical조회 또는 입력 방법: 실제 이벤트의 df_status를 사용하며, 보안 이벤트는 df_source=security도 설정합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].df_source | string | 선택 사항이며, 공개 대상 구조는 security만 지원합니다. 생략하면 실행 계층에서 보안 소스를 제외합니다. 예시: security조회 또는 입력 방법: 보안 모니터링 이벤트에만 security를 입력하고 일반 이벤트에서는 생략합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].to | array | member 모드에서는 email, sms 또는 notify_ 알림 대상을 주로 사용하며 알림 방식을 나타냅니다. 실행 계층은 직접 계정/팀 등의 대상도 호환하지만, memberInfo와 알림 방식 조합을 우선 사용하는 것이 좋습니다. 예시: ["email"]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].to[*] | string | member 모드에서는 email/sms/notify_를 주로 사용하고, status 모드에서는 acnt_/agent_/group_/notify_ 또는 이메일을 사용합니다. SMS 등 채널의 사용 가능 여부는 사이트 및 대상 구성에 따라 달라집니다. 예시: email조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].tags | json | status 모드에서는 필드 값으로 이벤트를 필터링합니다. member 모드에서는 상위 alertInfo.filterString을 사용해야 하며, 여기의 tags는 멤버 선택 조건으로 사용되지 않습니다. 예시: {"env": ["production"]}조회 또는 입력 방법: 이벤트 원본 필드와 값으로 딕셔너리를 구성합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].tags.字段 | array | 단일 필드의 매칭 값 배열입니다. 예시: ["production"]조회 또는 입력 방법: 키는 실제 이벤트 필드(예: env)를 사용하고, 값은 매칭할 실제 필드 값 배열을 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].tags.字段[*] | string | 단일 매칭 값입니다. 예시: production조회 또는 입력 방법: 이벤트의 동일한 필드에서 값을 가져옵니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].filterString | string | status 모드에서 값이 있으면 tags보다 우선하며 에스컬레이션 작업에도 사용됩니다. member 모드에서는 상위 alertInfo.filterString을 사용하며, 해당 대상 내 필드는 유효한 필터 진입점으로 사용되지 않습니다. 예시: env:production조회 또는 입력 방법: 서버 측 FilterString 문법을 사용합니다(예: env:production). 복잡한 조건은 콘솔에서 생성한 후 복사합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets | array | 선택적 에스컬레이션 작업입니다. 이벤트가 해당 등급으로 duration 동안 지속되면 실행되며, []는 에스컬레이션을 구성하지 않음을 의미합니다. 예시: [{"to": ["acnt_example"], "duration": 600, "toWay": ["email"]}]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*] | json | 단일 에스컬레이션 작업입니다. 예시: {"to": ["acnt_example"], "duration": 600, "toWay": ["email"]}조회 또는 입력 방법: 각 에스컬레이션마다 수신 대상과 대기 초를 선택합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].to | array | member 모드에서는 에스컬레이션 수신 멤버/팀이고, status 모드에서는 에스컬레이션 알림 대상이며 멤버/팀/알림 대상/이메일을 사용할 수 있습니다. 예시: ["acnt_example"]조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].to[*] | string | 단일 에스컬레이션 수신 식별자입니다. 예시: acnt_example조회 또는 입력 방법: 계정은 워크스페이스 멤버의 content.data[].uuid에서 가져오고, 팀은 멤버의 member_group 또는 팀 관리에서 group_ UUID를 가져오며, 알림 대상은 알림 대상 목록에서 UUID를 가져옵니다. 모두 현재 워크스페이스의 실제 리소스를 사용합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].duration | integer | 필수 지속 시간(초)입니다. 각 에스컬레이션은 이벤트 지속 상태를 기준으로 구성하며 여러 duration을 자동으로 누적하지 않습니다. 예시: 600조회 또는 입력 방법: 비즈니스 요구에 따라 양의 정수 초를 입력합니다. 예를 들어 600은 해당 등급이 10분간 지속됨을 의미합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].toWay | array | member 에스컬레이션 알림 방식 배열이며 status 모드에서는 이 필드를 사용하지 않습니다. 예시: ["email"]조회 또는 입력 방법: member 모드에서는 email/sms 또는 알림 대상 목록의 notify_ 객체 중에서 선택하고, status 모드에서는 생략합니다. |
|
| alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].toWay[*] | string | 단일 에스컬레이션 알림 방식입니다. 예시: email조회 또는 입력 방법: 실제 사용 가능한 email/sms 또는 알림 대상 UUID를 선택합니다. |
|
| alertOpt | json | 알림 구성 객체입니다. 생성 시 생략하면 빈 구성이 저장될 수 있고, 수정 시 전달하면 전체를 교체합니다. 객체를 제공하면 aggInterval이 필수 검증 필드입니다. null 허용: False 예시: {"alertType": "status", "aggInterval": 0, "silentTimeout": 900, "alertTarget": []}조회 또는 입력 방법: 아래 대상 구조에 따라 입력합니다. 수정 전에 상세 정보에서 전체 객체를 복사한 후 조정합니다. |
|
| alertOpt.aggClusterFields | array | 지능형 집계 텍스트 필드입니다. CLUSTER를 포함할 때는 df_title 또는 df_message를 하나 이상 선택해야 합니다. null 허용: False 예시: ["df_title"]조회 또는 입력 방법: CLUSTER 집계가 필요하면 제목 또는 내용 필드를 선택합니다. |
|
| alertOpt.aggFields | array | 필드 목록입니다. 사전 정의된 df_monitor_checker_id, df_dimension_tags, df_label, CLUSTER를 사용할 수 있으며, byCustom 모드에서는 비즈니스 사용자 지정 필드를 사용할 수 있습니다. v2 집계 모드는 aggType을 참고하세요. null 허용: False 예시: ["df_monitor_checker_id"]조회 또는 입력 방법: 어떤 이벤트를 같은 그룹으로 묶을지에 따라 다음 필드를 선택합니다. []는 전체 집계를 의미합니다. |
|
| alertOpt.aggInterval | integer | 조건부 필수 | alertOpt를 제공할 때 필수이며 0~1800초입니다. 0은 집계하지 않으며, byAI를 선택하더라도 유효한 AI 집계가 활성화됨을 의미하지 않습니다. null 허용: False $maxValue: 1800 $minValue: 0 예시: 0조회 또는 입력 방법: 집계가 필요하면 대기할 초를 입력하고, 집계하지 않으면 0을 입력합니다. |
| alertOpt.aggLabels | array | 태그 기준 집계의 태그 값 배열입니다. df_label을 선택하면 비어 있지 않은 배열을 제공해야 합니다. null 허용: False 예시: ["production"]조회 또는 입력 방법: 이벤트 태그에서 실제 태그 값을 가져옵니다. aggFields에 df_label이 포함된 경우에만 사용합니다. |
|
| alertOpt.alertTarget | array | 알림 규칙 배열입니다. status 모드에서는 targets에 등급 작업을 배치하고, member 모드에서는 alertInfo에 멤버 및 알림 방식을 구성합니다. null 허용: False 예시: [{"name": "默认通知", "targets": [{"status": "critical", "to": ["notify_example"]}]}]조회 또는 입력 방법: 비즈니스 시간과 수신 규칙에 따라 배열을 구성하며, 작업이 없으면 []를 사용합니다. |
|
| alertOpt.alertType | string | status는 등급 기준, member는 멤버 기준이며 생략하면 기본값 status입니다. 두 모드는 targets 계층이 달라 함께 사용할 수 없습니다. null 허용: False 선택 가능한 값: ['status', 'member'] 예시: status조회 또는 입력 방법: 등급별 수신자 선택 또는 멤버별 알림 방식 선택 중 하나를 선택합니다. |
|
| alertOpt.silentTimeout | integer | 통합 반복 알림 간격이며, 생략하면 실행 기본값은 900초입니다. 0은 이번 주기에 더 이상 반복하지 않음을 의미합니다. 0이 아니고 300 미만이면 실행 시 300초로 처리합니다. null을 전달하지 마세요. null 허용: False 예시: 900조회 또는 입력 방법: 동일 유형 알림의 최소 반복 전송 간격을 초 단위로 입력합니다. |
|
| alertOpt.silentTimeoutByStatus | array | 등급별 반복 간격 배열입니다. 활성화 시 제어해야 하는 등급을 포함해야 합니다. 이 등급별 구성은 통합 silentTimeout의 300초 정규화를 거치지 않습니다. null 허용: False 예시: [{"status": "critical,error", "silentTimeout": 600}]조회 또는 입력 방법: 실제 이벤트 소스와 등급에 따라 각각 설정하고, 아래 등급별 배열 구조를 사용합니다. |
|
| alertOpt.silentTimeoutByStatusEnable | boolean | 생성 시 기본값 false이면 silentTimeout을 사용하고, true이면 silentTimeoutByStatus에 따라 상태별 간격을 펼칩니다. null 허용: False 예시: false조회 또는 입력 방법: 이벤트 등급별로 반복 간격을 각각 설정해야 하면 true를 입력합니다. |
|
| desc | string | 선택적 설명이며 최대 256자입니다. 생성 시 생략하면 빈 문자열이 되고, 수정 시 생략하면 유지되며, 빈 문자열이면 비웁니다. 빈 문자열 허용: True null 허용: False 최대 길이: 256 예시: 生产服务异常通知与升级。조회 또는 입력 방법: 정책이 담당하는 비즈니스 범위에 따라 입력합니다. |
|
| name | string | 선택적 새 이름이며 생략하면 유지됩니다. 심층 매개변수 검증을 트리거하려면 기존 name을 제출하는 것이 좋습니다. null 허용: False 예시: 生产服务告警조회 또는 입력 방법: 알림 정책 목록에서 이 워크스페이스의 기존 이름을 확인하고, 사용되지 않은 이름을 선택합니다. |
|
| openPermissionSet | boolean | 선택적 사용자 지정 작업 권한 스위치이며 생성 기본값은 false입니다. 수정 시 생략하면 유지됩니다. 활성화하면 생성자, owner 및 고급 작업 권한 또는 permissionSet에 해당하는 ID가 작업할 수 있습니다. null 허용: False 예시: false조회 또는 입력 방법: 특정 역할, 팀, 멤버로 편집 등의 작업을 제한해야 하면 활성화하고, 일반적으로 API 권한으로 제어하면 비활성화합니다. |
|
| permissionSet | array | 사용자 지정 작업 주체의 전체 배열이며 역할, 계정, 팀 식별자를 넣을 수 있습니다. 생성 시 생략하면 []이고, 수정 시 전달하면 전체를 교체하며 []이면 비웁니다. 생성자와 owner는 빈 배열로 인해 잠기지 않습니다. null 허용: False 예시: ["wsAdmin"]조회 또는 입력 방법: 워크스페이스 역할에서 역할 UUID를 가져오고, 워크스페이스 멤버에서 계정/팀 UUID를 가져옵니다. 역할 표시 이름을 입력하지 마세요. |
|
| ruleTimezone | str | Y | 생성과 수정 모두 필수인 시간대 문자열이며 정책 엔터티에 저장됩니다. 현재 공개 버전에는 실행 시 읽는 위치의 차이가 있습니다. null 허용: False 예시: Asia/Shanghai조회 또는 입력 방법: 비즈니스 요구에 따라 IANA 시간대를 선택합니다(예: Asia/Shanghai). 현재 실행 측 제한은 사용법 설명을 참고하세요. |
매개변수 추가 설명¶
status 모드에서는 alertTarget[].targets를 구성하고, member 모드에서는 alertTarget[].alertInfo[].memberInfo 및 targets를 구성합니다. 에스컬레이션 수신자는 to, 알림 방식은 toWay를 사용합니다. 주기 창은 crontab+crontabDuration을 입력하고, 지정 날짜 창은 customDateUUIDs+customStartTime+customDuration을 입력하며 crontabDuration을 customDuration으로 사용할 수 없습니다.
멤버 모드 요청 본문 구조 예시(이 페이지의 URL로 제출하며, 예시 계정/팀은 교체해야 합니다):
{
"name": "生产服务告警",
"ruleTimezone": "Asia/Shanghai",
"alertOpt": {
"alertType": "member",
"aggInterval": 0,
"silentTimeout": 900,
"alertTarget": [
{
"name": "默认成员通知",
"alertInfo": [
{
"name": "生产负责人",
"memberInfo": [
"acnt_example"
],
"filterString": "env:production",
"targets": [
{
"status": "critical",
"to": [
"email"
],
"upgradeTargets": [
{
"to": [
"group_example"
],
"duration": 600,
"toWay": [
"email"
]
}
]
}
]
}
]
}
]
}
}
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/alert_policy/altpl_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产服务告警","ruleTimezone":"Asia/Shanghai","alertOpt":{"alertType":"status","aggInterval":0,"silentTimeout":900,"alertTarget":[{"name":"默认通知","targets":[{"status":"critical","to":["notify_example"]}]}]}}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 정책 레코드 번호이며 생성 응답에서는 아직 할당되지 않았을 수 있습니다. 작업에는 uuid를 사용합니다. |
| content.uuid | string | altpl_ 알림 정책 UUID입니다. |
| content.workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.name | string | 정책 이름입니다. |
| content.desc | string | 정책 설명입니다. |
| content.ruleTimezone | string | 저장된 엔터티 시간대입니다. 실행 시 읽기 차이는 사용법을 참고하며, 시간대가 적용되었음을 증명하지는 않습니다. |
| content.score | integer | 정책 점수 필드이며 생성 기본값은 0이고, 이 공개 요청에서는 해당 필드를 제공하지 않습니다. |
| content.openPermissionSet | boolean | 사용자 지정 작업 권한 스위치입니다. |
| content.permissionSet | array<string> |
작업 가능한 역할/멤버/팀 식별자입니다. |
| content.permissionSet[] | string | 단일 주체 식별자입니다. |
| content.status | integer | 레코드 상태이며 0은 활성, 2는 비활성, 3은 삭제입니다. 목록에는 삭제되지 않은 정책이 표시됩니다. |
| content.creator | string | 생성 ID입니다. |
| content.updator | string | 최근 업데이트 ID입니다. |
| content.createAt | integer | 생성 시간(Unix 초)입니다. |
| content.updateAt | integer | 업데이트 시간(Unix 초)이며 초기값은 -1입니다. |
| content.deleteAt | integer | 삭제 시간(Unix 초)이며 삭제되지 않았으면 -1입니다. |
| content.alertOpt | object | 저장된 구성: 알림 구성 객체입니다. 생성 시 생략하면 빈 구성이 저장될 수 있고, 수정 시 전달하면 전체를 교체합니다. 객체를 제공하면 aggInterval이 필수 검증 필드입니다. |
| content.alertOpt.alertType | string | 저장된 구성: status는 등급 기준, member는 멤버 기준이며 생략하면 기본값 status입니다. 두 모드는 targets 계층이 달라 함께 사용할 수 없습니다. |
| content.alertOpt.silentTimeout | integer | 저장된 구성: 통합 반복 알림 간격이며, 생략하면 실행 기본값은 900초입니다. 0은 이번 주기에 더 이상 반복하지 않음을 의미합니다. 0이 아니고 300 미만이면 실행 시 300초로 처리합니다. null을 전달하지 마세요. |
| content.alertOpt.silentTimeoutByStatusEnable | boolean | 저장된 구성: 생성 시 기본값 false이면 silentTimeout을 사용하고, true이면 silentTimeoutByStatus에 따라 상태별 간격을 펼칩니다. |
| content.alertOpt.silentTimeoutByStatus | array<object> |
저장된 구성: 등급별 반복 간격 배열입니다. 활성화 시 제어해야 하는 등급을 포함해야 합니다. 이 등급별 구성은 통합 silentTimeout의 300초 정규화를 거치지 않습니다. |
| content.alertOpt.silentTimeoutByStatus[] | object | 저장된 구성: 등급별 간격 객체입니다. |
| content.alertOpt.silentTimeoutByStatus[].status | string | 저장된 구성: 비보안은 fatal/critical/error/warning/nodata/info/ALL을 사용할 수 있고, 보안은 security_critical/security_high/security_medium/security_low/security_info/security_ALL을 사용합니다. 여러 값은 영문 쉼표로 연결하며 공백을 넣지 않습니다. |
| content.alertOpt.silentTimeoutByStatus[].silentTimeout | integer | 저장된 구성: 각 그룹의 필수 반복 간격이며 단위는 초입니다. 잘못된 등급은 내부 오류를 유발할 수 있으므로 전송 전에 검증하세요. |
| content.alertOpt.aggInterval | integer | 저장된 구성: alertOpt를 제공할 때 필수이며 0~1800초입니다. 0은 집계하지 않으며, byAI를 선택하더라도 유효한 AI 집계가 활성화됨을 의미하지 않습니다. |
| content.alertOpt.aggFields | array<string> |
저장된 구성: 필드 목록입니다. 사전 정의된 df_monitor_checker_id, df_dimension_tags, df_label, CLUSTER를 사용할 수 있으며, byCustom 모드에서는 비즈니스 사용자 지정 필드를 사용할 수 있습니다. v2 집계 모드는 aggType을 참고하세요. |
| content.alertOpt.aggFields[] | string | 저장된 구성: 단일 집계 필드입니다. byCustom은 실제 이벤트 필드를 기준으로 선택하며, 표시 이름만으로 필드를 추측하지 마세요. |
| content.alertOpt.aggLabels | array<string> |
저장된 구성: 태그 기준 집계의 태그 값 배열입니다. df_label을 선택하면 비어 있지 않은 배열을 제공해야 합니다. |
| content.alertOpt.aggLabels[] | string | 저장된 구성: 단일 태그 값입니다. |
| content.alertOpt.aggClusterFields | array<string> |
저장된 구성: 지능형 집계 텍스트 필드입니다. CLUSTER를 포함할 때는 df_title 또는 df_message를 하나 이상 선택해야 합니다. |
| content.alertOpt.aggClusterFields[] | string | 저장된 구성: 단일 텍스트 필드입니다. |
| content.alertOpt.alertTarget | array<object> |
저장된 구성: 알림 규칙 배열입니다. status 모드에서는 targets에 등급 작업을 배치하고, member 모드에서는 alertInfo에 멤버 및 알림 방식을 구성합니다. |
| content.alertOpt.alertTarget[] | object | 저장된 구성: 규칙 객체입니다. 폴백이 필요하면 시간 구성이 없는 규칙을 명시적으로 추가하며, 시스템이 자동으로 보완한다고 가정하지 마세요. |
| content.alertOpt.alertTarget[].name | string | 저장된 구성: 선택적 규칙 이름이며 최대 256자입니다. |
| content.alertOpt.alertTarget[].crontab | string | 저장된 구성: 주기 시작 시간 표현식이며 crontabDuration과 쌍을 이뤄야 합니다. 사용자 지정 날짜 방식과 둘 중 하나를 선택합니다. |
| content.alertOpt.alertTarget[].crontabDuration | integer | 저장된 구성: 주기 창의 지속 시간(초)입니다. crontab을 제공할 때 반드시 함께 제공해야 하며, 반복 시간 구간을 구성하지 않으면 둘 다 생략합니다. |
| content.alertOpt.alertTarget[].customDateUUIDs | array<string> |
저장된 구성: 사용자 지정 날짜 집합 참조이며 최대 366개 항목입니다. customStartTime, customDuration과 함께 제공해야 하며 crontabDuration으로 대체할 수 없습니다. |
| content.alertOpt.alertTarget[].customDateUUIDs[] | string | 저장된 구성: 단일 날짜 구성 UUID입니다. |
| content.alertOpt.alertTarget[].customStartTime | string | 저장된 구성: 사용자 지정 날짜 당일의 시작 시각이며 customDateUUIDs/customDuration과 함께 사용합니다. |
| content.alertOpt.alertTarget[].customDuration | integer | 저장된 구성: 사용자 지정 날짜 창의 지속 시간(초)이며 날짜 집합 및 시작 시각과 반드시 함께 제공해야 합니다. |
| content.alertOpt.alertTarget[].targets | array<object> |
저장된 구성: status 모드 작업 배열입니다. |
| content.alertOpt.alertTarget[].targets[] | object | 저장된 구성: 단일 등급 작업입니다. |
| content.alertOpt.alertTarget[].targets[].status | string | 저장된 구성: 필수 등급 선택: fatal, critical, error, warning, nodata, info이며 전체는 대문자 ALL을 사용합니다. 여러 값은 영문 쉼표로 연결하고 공백을 넣지 않습니다. security 소스는 critical, high, medium, low, info 또는 ALL을 사용합니다. |
| content.alertOpt.alertTarget[].targets[].df_source | string | 저장된 구성: 선택 사항이며, 공개 대상 구조는 security만 지원합니다. 생략하면 실행 계층에서 보안 소스를 제외합니다. |
| content.alertOpt.alertTarget[].targets[].to | array<string> |
저장된 구성: 필수 수신 대상 배열이며 멤버, 팀, 알림 대상 또는 이메일을 사용할 수 있습니다. 에이전트 계정은 유효한 기본 Webhook을 사용할 수 있습니다. |
| content.alertOpt.alertTarget[].targets[].to[] | string | 저장된 구성: member 모드에서는 email/sms/notify_를 주로 사용하고, status 모드에서는 acnt_/agent_/group_/notify_ 또는 이메일을 사용합니다. SMS 등 채널의 사용 가능 여부는 사이트 및 대상 구성에 따라 달라집니다. |
| content.alertOpt.alertTarget[].targets[].tags | object | 저장된 구성: status 모드에서는 필드 값으로 이벤트를 필터링합니다. member 모드에서는 상위 alertInfo.filterString을 사용해야 하며, 여기의 tags는 멤버 선택 조건으로 사용되지 않습니다. |
| content.alertOpt.alertTarget[].targets[].tags.字段 | array<object> |
저장된 구성: 단일 필드의 매칭 값 배열입니다. |
| content.alertOpt.alertTarget[].targets[].tags.字段[] | string | 저장된 구성: 단일 매칭 값입니다. |
| content.alertOpt.alertTarget[].targets[].filterString | string | 저장된 구성: status 모드에서 값이 있으면 tags보다 우선하며 에스컬레이션 작업에도 사용됩니다. member 모드에서는 상위 alertInfo.filterString을 사용하며, 해당 대상 내 필드는 유효한 필터 진입점으로 사용되지 않습니다. |
| content.alertOpt.alertTarget[].targets[].upgradeTargets | array<object> |
저장된 구성: 선택적 에스컬레이션 작업입니다. 이벤트가 해당 등급으로 duration 동안 지속되면 실행되며, []는 에스컬레이션을 구성하지 않음을 의미합니다. |
| content.alertOpt.alertTarget[].targets[].upgradeTargets[] | object | 저장된 구성: 단일 에스컬레이션 작업입니다. |
| content.alertOpt.alertTarget[].targets[].upgradeTargets[].to | array<string> |
저장된 구성: member 모드에서는 에스컬레이션 수신 멤버/팀이고, status 모드에서는 에스컬레이션 알림 대상이며 멤버/팀/알림 대상/이메일을 사용할 수 있습니다. |
| content.alertOpt.alertTarget[].targets[].upgradeTargets[].to[] | string | 저장된 구성: 단일 에스컬레이션 수신 식별자입니다. |
| content.alertOpt.alertTarget[].targets[].upgradeTargets[].duration | integer | 저장된 구성: 필수 지속 시간(초)입니다. 각 에스컬레이션은 이벤트 지속 상태를 기준으로 구성하며 여러 duration을 자동으로 누적하지 않습니다. |
| content.alertOpt.alertTarget[].targets[].upgradeTargets[].toWay | array<string> |
저장된 구성: member 에스컬레이션 알림 방식 배열이며 status 모드에서는 이 필드를 사용하지 않습니다. |
| content.alertOpt.alertTarget[].targets[].upgradeTargets[].toWay[] | string | 저장된 구성: 단일 에스컬레이션 알림 방식입니다. |
| content.alertOpt.alertTarget[].alertInfo | array<object> |
저장된 구성: member 모드에서만 사용하는 멤버 그룹 배열이며 status 모드에서는 사용하지 않습니다. |
| content.alertOpt.alertTarget[].alertInfo[] | object | 저장된 구성: 멤버 그룹 객체입니다. |
| content.alertOpt.alertTarget[].alertInfo[].name | string | 저장된 구성: 선택적 멤버 그룹 이름이며 최대 256자입니다. |
| content.alertOpt.alertTarget[].alertInfo[].memberInfo | array<string> |
저장된 구성: 멤버 모드 일반 알림의 수신 멤버/팀 배열이며 에이전트 계정을 포함할 수 있습니다. targets.to 알림 방식과 조합됩니다. |
| content.alertOpt.alertTarget[].alertInfo[].memberInfo[] | string | 저장된 구성: 단일 멤버 또는 팀 식별자입니다. |
| content.alertOpt.alertTarget[].alertInfo[].filterString | string | 저장된 구성: 멤버 그룹 수준 이벤트 필터이며 일반 및 에스컬레이션 작업 모두 이 조건을 사용합니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets | array<object> |
저장된 구성: 멤버 모드의 알림 방식/등급 작업 배열입니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[] | object | 저장된 구성: 단일 등급 작업입니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].status | string | 저장된 구성: 필수 등급 선택: fatal, critical, error, warning, nodata, info이며 전체는 대문자 ALL을 사용합니다. 여러 값은 영문 쉼표로 연결하고 공백을 넣지 않습니다. security 소스는 critical, high, medium, low, info 또는 ALL을 사용합니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].df_source | string | 저장된 구성: 선택 사항이며, 공개 대상 구조는 security만 지원합니다. 생략하면 실행 계층에서 보안 소스를 제외합니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].to | array<string> |
저장된 구성: member 모드에서는 email, sms 또는 notify_ 알림 대상을 주로 사용하며 알림 방식을 나타냅니다. 실행 계층은 직접 계정/팀 등의 대상도 호환하지만, memberInfo와 알림 방식 조합을 우선 사용하는 것이 좋습니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].to[] | string | 저장된 구성: member 모드에서는 email/sms/notify_를 주로 사용하고, status 모드에서는 acnt_/agent_/group_/notify_ 또는 이메일을 사용합니다. SMS 등 채널의 사용 가능 여부는 사이트 및 대상 구성에 따라 달라집니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].tags | object | 저장된 구성: status 모드에서는 필드 값으로 이벤트를 필터링합니다. member 모드에서는 상위 alertInfo.filterString을 사용해야 하며, 여기의 tags는 멤버 선택 조건으로 사용되지 않습니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].tags.字段 | array<object> |
저장된 구성: 단일 필드의 매칭 값 배열입니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].tags.字段[] | string | 저장된 구성: 단일 매칭 값입니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].filterString | string | 저장된 구성: status 모드에서 값이 있으면 tags보다 우선하며 에스컬레이션 작업에도 사용됩니다. member 모드에서는 상위 alertInfo.filterString을 사용하며, 해당 대상 내 필드는 유효한 필터 진입점으로 사용되지 않습니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets | array<object> |
저장된 구성: 선택적 에스컬레이션 작업입니다. 이벤트가 해당 등급으로 duration 동안 지속되면 실행되며, []는 에스컬레이션을 구성하지 않음을 의미합니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[] | object | 저장된 구성: 단일 에스컬레이션 작업입니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].to | array<string> |
저장된 구성: member 모드에서는 에스컬레이션 수신 멤버/팀이고, status 모드에서는 에스컬레이션 알림 대상이며 멤버/팀/알림 대상/이메일을 사용할 수 있습니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].to[] | string | 저장된 구성: 단일 에스컬레이션 수신 식별자입니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].duration | integer | 저장된 구성: 필수 지속 시간(초)입니다. 각 에스컬레이션은 이벤트 지속 상태를 기준으로 구성하며 여러 duration을 자동으로 누적하지 않습니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].toWay | array<string> |
저장된 구성: member 에스컬레이션 알림 방식 배열이며 status 모드에서는 이 필드를 사용하지 않습니다. |
| content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].toWay[] | string | 저장된 구성: 단일 에스컬레이션 알림 방식입니다. |
| content.alertOpt.aggType | string | 저장된 구성: v2 선택 모드: byFields 규칙 집계, byCluster 지능형 집계, byAI AI 집계, byCustom 사용자 지정 필드 규칙 집계입니다. 생략하거나 null이면 기존 aggFields 로직을 따르며, 집계에는 여전히 aggInterval>0이 필요합니다. |
| content.alertOpt.ignoreOK | boolean | 저장된 구성: v2 선택 사항이며 정상 등급 알림을 무시하고 기본값은 false입니다. |
| content.alertOpt.aggSendFirst | boolean | 저장된 구성: v2 선택 사항이며 집계 시 첫 번째 항목을 즉시 전송할지 여부이고 기본값은 false입니다. aggInterval=0이면 유효한 집계가 구성되지 않습니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언입니다. 쓰기 API는 저장된 엔터티만 반환하며 조회 시 추가 필드는 포함하지 않습니다. |
{
"code": 200,
"content": {
"id": 42,
"uuid": "altpl_example",
"workspaceUUID": "wksp_example",
"name": "生产服务告警",
"desc": "生产服务异常通知与升级。",
"alertOpt": {
"alertType": "status",
"aggInterval": 0,
"silentTimeout": 900,
"alertTarget": [
{
"name": "默认通知",
"targets": [
{
"status": "critical",
"to": [
"notify_example"
]
}
]
}
]
},
"ruleTimezone": "Asia/Shanghai",
"score": 0,
"openPermissionSet": false,
"permissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785430800,
"updateAt": 1785430860,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 | 매개변수 파싱 실패 | 매개변수 위치, 필드 이름, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아닙니다 | 일부 json 파일 형식 오류 | 단일 JSON 객체를 제출합니다. |
| 400 | ft.AlertPolicyNameRepeat | 삭제되지 않은 동일 이름 정책이 있거나 짧은 시간 내 동시 생성이 해당 이름을 선점했습니다 | 알림 정책 이름 중복 | 먼저 이미 생성되었는지 조회하고, 잠시 후 이름을 바꿔 재시도할지 확인합니다. |
| 400 | ft.ParamsValidateError | status/member 작업 구조 또는 시간 필드 의존성이 규칙에 맞지 않습니다 | 매개변수 검증 실패: {} | 이 페이지의 해당 모드에 따라 필수 필드를 보완합니다. custom 날짜에는 customDuration이 필요하며 crontabDuration으로 대체하지 않습니다. |
| 400 | ft.InvalidEventStatus | status 모드 이벤트 등급이 해당 일반/보안 열거형에 없습니다 | 유효하지 않은 이벤트 상태: {} | 이 페이지의 대문자 ALL 및 올바른 소스 열거형을 사용하고 쉼표 사이에 공백을 넣지 마세요. |
| 406 | ft.InvalidCrontabFormat | 주기 표현식을 파싱할 수 없습니다 | 유효하지 않은 crontab 형식 | 유효한 Cron 표현식을 사용하고 crontabDuration을 제공합니다. |
| 400 | ft.ErrorFilterString | filterString을 파싱할 수 없습니다 | filterString 파싱 실패: {} | 먼저 콘솔 필터에서 유효한 조건을 생성하거나 예시에 따라 수정합니다. |
| 400 | ft.InvalidCustomNoticeDateUUID | 참조한 날짜 구성이 존재하지 않거나 삭제되었거나 현재 워크스페이스에 속하지 않습니다 | 유효하지 않은 사용자 지정 날짜 UUIDs: {} | 사용자 지정 알림 날짜를 통해 유효한 UUID를 다시 가져옵니다. |
| 400 | ft.InvalidAggFields | byCustom 모드가 아닌데 검증에 맞지 않는 집계 필드를 제공했습니다 | 유효하지 않은 집계 유형 | 사전 정의된 필드를 선택하거나, v2에서 byCustom을 명확히 선택하고 실제 비즈니스 필드를 사용합니다. |
| 400 | ft.TagFieldMissing | df_label 집계를 선택했지만 비어 있지 않은 aggLabels를 제공하지 않았습니다 | 태그 누락 | 실제 태그 값 배열을 제공합니다. |
| 400 | ft.InvalidAggClusterFields | CLUSTER를 선택했지만 제목 또는 내용 집계 필드를 제공하지 않았습니다 | 유효하지 않은 집계 필드 | aggClusterFields에 df_title 또는 df_message를 하나 이상 포함합니다. |
| 400 | ft.UnsupportExternalEmail | 제한된 워크스페이스 버전에서 status 대상에 외부 이메일을 사용했습니다 | 무료 플랜 워크스페이스에서는 알림 대상이 외부 이메일인 것을 지원하지 않습니다 | 현재 워크스페이스 멤버를 선택하거나 버전 및 채널 지원을 확인합니다. |
| 500 | ft.InternalServerError | 등급별 반복 알림 상태의 동일 값이 직접 예외를 트리거했거나 저장/캐시/기타 내부 처리에 실패했습니다 | 내부 오류 | 이 페이지의 열거형과 전체 구조로 먼저 자체 점검하고, 저장된 상태를 조회한 후 재시도 여부를 결정합니다. 지속적으로 실패하면 traceId를 제공합니다. |
| 404 | ft.NotFound | 정책이 존재하지 않거나 삭제되었거나 현재 워크스페이스에 속하지 않습니다 | 비즈니스 라우트를 찾을 수 없습니다 | 알림 정책 목록에서 유효한 UUID를 다시 가져옵니다. |
| 403 | ft.ForbiddenAlertPolicyOperation | 현재 ID가 정책의 사용자 지정 작업 권한을 통과하지 못했습니다 | 알림 정책【{}】에 대한 작업 권한이 없습니다 | 생성자, owner 또는 권한이 부여된 주체가 작업하며, 먼저 permissionSet을 확인합니다. |
| 403 | ft.Forbidden | 사용자 지정 권한이 꺼진 상태에서 현재 ID에 API 작업 권한이 없습니다 | 작업 권한이 없습니다 | 작업 권한이 있는 API Key를 사용합니다. |