차단 연동 수정
지정한 차단 연동 설정을 수정합니다.
필요 권한
관리자 이상의 계정으로 이용할 수 있습니다.
HTTP 요청
PUT /api/sonar/response-targets/:guid
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
-d name="방화벽 차단 연동" \
-d description="경계 방화벽으로 공격자 IP 차단" \
-d model_type="bluemax-ngf" \
-d profile_guid="66666666-7777-8888-9999-000000000000" \
-d 'configs={}' \
-d ip_blacklist_guid="4dc14f3d-ebf8-4032-8a7a-ef9ec6cd3dd2" \
-X PUT \
https://HOSTNAME/api/sonar/response-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890
요청 매개변수
경로 매개변수
| 키 | 타입 | 설명 | 비고 |
|---|---|---|---|
| guid | 문자열 | 차단 연동 설정 GUID | 36자 |
요청 본문 매개변수
| 키 | 필수 | 타입 | 설명 | 비고 |
|---|---|---|---|---|
| name | O | 문자열 | 차단 연동 설정 이름 | 최소 1자, 최대 50자 |
| description | X | 문자열 | 설명 | 최대 2,000자 |
| model_type | O | 문자열 | 차단 연동 모델 유형 코드 | 설치된 차단 연동 지원 앱이 제공하는 값 |
| profile_guid | O | 문자열 | 접속 프로파일 GUID | 36자 |
| configs | O | 문자열 키/값 | 차단 연동 모델별 설정 값 | JSON 객체 |
| ip_blacklist_guid | O | 문자열 | 차단 대상 IP를 등록할 주소 그룹 GUID | 36자 |
Note
차단 연동 수정은 부분 수정을 지원하지 않습니다. name, model_type, profile_guid, configs, ip_blacklist_guid를 모두 다시 전달해야 하며, 미전달 시 필수 매개변수 누락 오류가 반환됩니다.
정상 응답
{}
오류 응답
필수 매개변수가 누락된 경우
HTTP 상태 코드 400 응답
{
"error_code": "null-argument",
"error_msg": "name should be not null"
}
guid가 GUID 형식이 아닌 경우
HTTP 상태 코드 400 응답
{
"error_code": "invalid-param-type",
"error_msg": "guid should be guid type."
}
차단 연동 모델을 찾을 수 없는 경우
HTTP 상태 코드 500 응답
{
"error_code": "response-model-not-found",
"error_msg": null
}
주소 그룹이 존재하지 않는 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "address group not found: 4dc14f3d-ebf8-4032-8a7a-ef9ec6cd3dd2"
}
접속 프로파일이 존재하지 않는 경우
HTTP 상태 코드 500 응답
{
"error_code": "profile-not-found",
"error_msg": null
}
지정한 차단 연동 설정이 존재하지 않는 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "target-not-found"
}
차단 연동 설정 이름이 이미 존재하는 경우
name을 기존 값과 다른 값으로 변경할 때만 중복 검사가 수행됩니다. name을 변경하지 않으면 이 오류는 발생하지 않습니다.
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "duplicated response target name: 방화벽 차단 연동"
}
configs 값이 너무 큰 경우
HTTP 상태 코드 400 응답
{
"error_code": "invalid-argument",
"error_msg": "too long response target configs (> 65535)"
}
권한이 없는 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "no-permission"
}