행위 프로파일 추가

새로운 행위 프로파일을 추가합니다.

필요 권한

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

HTTP 요청

POST /api/sonar/behavior-profiles
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
     -d name="사용자 로그인 행위" \
     -d description="사용자별 로그인 패턴 프로파일" \
     -d schedule="0 0 2 * * ?" \
     -d query="table login | stats count by user" \
     -d key_fields='[{"name":"user","type":"string"}]' \
     -d shared_users='[]' \
     -d shared_groups='[]' \
     -X POST \
     https://HOSTNAME/api/sonar/behavior-profiles
요청 매개변수
필수타입설명비고
nameO문자열프로파일 이름-
descriptionX문자열프로파일 설명-
scheduleO문자열빌드 주기를 나타내는 cron 표현식-
key_fieldsX객체 배열키 필드 목록-
queryO문자열프로파일 빌드에 사용하는 쿼리-
shared_usersO객체 배열공유 대상 계정 목록-
shared_groupsO객체 배열공유 대상 계정 그룹 목록-

key_fields 객체 속성

  • name (문자열): 키 필드 이름
  • type (문자열): 키 필드 데이터 타입

shared_users 객체 속성

각 요소는 GUID 문자열이거나 다음 속성을 가진 객체입니다.

  • guid (문자열): 공유 대상 GUID. 필수
  • name (문자열, 선택적): 공유 대상 이름
  • read_only (불리언, 선택적): 읽기 전용 여부
  • id (32비트 정수, 선택적): 공유 대상 내부 식별자

shared_groups 객체 속성

shared_users와 동일한 구조입니다. 각 요소는 GUID 문자열이거나 위와 동일한 속성을 가진 객체입니다.

정상 응답

{}

오류 응답

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

HTTP 상태 코드 400 응답

{
  "error_code": "null-argument",
  "error_msg": "name should be not null"
}
프로파일 이름이 이미 존재하는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "duplicated behavior profile name: 사용자 로그인 행위"
}
권한이 없는 경우

HTTP 상태 코드 500 응답

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