수집기 수정

지정한 수집기의 설정을 수정합니다. 새 수집기는 수집기 생성 API로 만들 수 있습니다.

필요 권한

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

HTTP 요청

PUT /api/sonar/loggers/:guid

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d name="WTMP" \
     -d description="demo" \
     -d interval=10000 \
     -d 'configs={"path": "/var/log/wtmp"}' \
     -X PUT \
     https://HOSTNAME/api/sonar/loggers/b90ea540-4f47-4bcf-b708-af610a649c50

요청 매개변수

경로 매개변수

키	타입	설명	비고
guid	문자열	수집기 식별자	36자 GUID

요청 본문 매개변수

키	필수	타입	설명	비고
name	O	문자열	수집기 이름	최대 50자
description	X	문자열	수집기 설명	최대 2,000자
interval	X	32비트 정수	수집 간격	최소 `1000`, 최대 `1000000000` (단위: 밀리초)
cron_schedule	X	문자열	수집 주기	CRON 문법으로 작성된 일정. 최대 360자
asset_guid	X	문자열	자산 식별자	자산 IP 주소의 GUID
configs	X	문자열 키/값	설정	수집 유형별 설정 명세 확인

Tip

수집 모델, 테이블, 센트리 설정은 수정할 수 없으며, 요청에 포함하더라도 기존 값이 그대로 유지됩니다.

정상 응답

{}

오류 응답

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

HTTP 상태 코드 400 응답

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

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

HTTP 상태 코드 400 응답

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

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

HTTP 상태 코드 400 응답

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

수집 일정 문법이 잘못된 경우

HTTP 상태 코드 400 응답

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

자산이 존재하지 않는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "asset not found: cd09ae6f-fbc3-11ed-9320-02d178f999a6"
}

수집기가 존재하지 않는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "logger not found: c90ea540-4f47-4bcf-b708-af610a649c50"
}

권한이 없는 경우

HTTP 상태 코드 500 응답

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