배치 탐지 시나리오 생성

새 배치 탐지 시나리오를 생성합니다. 기존 시나리오의 설정은 배치 탐지 시나리오 수정 API로 변경할 수 있습니다.

필요 권한

관리자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d priority="LOW" \
     -d name="웹 취약점 스캔" \
     -d schedule="*/30 * * * *" \
     -d msg="웹 취약점 스캔: $dst_ip" \
     -d query="table duration=30m weblog | search status >= 400 | stats count as error_count, dc(path) as page_count by src_ip | search error_count > 100" \
     -X POST \
     https://HOSTNAME/api/sonar/batch-rules

요청 매개변수

정상 응답

{
  "guid": "410fe6af-b2f8-4674-af70-8d5b12ddc3fe"
}

• guid (문자열): 생성된 배치 탐지 시나리오 GUID

오류 응답

필수 매개변수가 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "name should be not null"
}

매개변수 값의 길이가 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'address_field' must be shorter than or equal to 50 characters."
}

잘못된 중요도 값을 사용한 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "priority should be one of 'LOW', 'MEDIUM', 'HIGH'."
}

식별자가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "category_guid should be guid type."
}

일정 CRON 문법이 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "schedule has wrong cron expression format: * * * * * *"
}

데이터셋과 쿼리 모두 지정하지 않은 경우

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "query should be not null"
}

시간 절사 값이 유효하지 않은 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "datetrunc should be one of 1 (1 second), 60 (1 minute), 3600 (1 hour), 86400 (1 day)."
}

field_order에 파이프 문자가 포함된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "field_order doesn't allow pipe characters."
}

이름이 중복된 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "duplicated batch rule name: 웹 취약점 스캔"
}

시나리오 생성 권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}