접속 프로파일 연결 테스트

지정한 접속 프로파일 유형과 설정 값으로 동기적으로 연결을 시도하고, 결과(result, 실패 시 msg)를 즉시 응답에 담아 반환합니다. 호출은 연결 결과가 확정될 때까지 차단됩니다. 기존 접속 프로파일의 GUID를 함께 지정하면 보호되는 설정 값(예: 비밀번호)이 누락된 경우 기존 값을 자동으로 채워서 테스트합니다.

이 API는 접속 프로파일 생성·수정 폼에서 입력 중인 설정의 연결 가능 여부만 빠르게 확인하기 위한 용도이며, type과 configs만 있으면 호출할 수 있습니다. 별도의 상태 조회·중단 API는 없습니다. 정식 등록 흐름과 동일한 매개변수로 본격적인 비동기 검증을 수행하려면 접속 프로파일 테스트를 사용하세요.

필요 권한

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

HTTP 요청

GET /api/sonar/connect-profiles/test-connect

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -G \
     --data-urlencode "type=jdbc" \
     --data-urlencode 'configs={"connection_string":"jdbc:hsqldb:file:testdb","user":"SA","password":"","read_only":false}' \
     "https://HOSTNAME/api/sonar/connect-profiles/test-connect"

요청 매개변수

키	필수	타입	설명	비고
type	O	문자열	접속 프로파일 유형	예: `jdbc`, `ssh`
configs	O	문자열 키/값	연결 시 사용할 설정 값	JSON 형식 문자열
guid	X	문자열	기존 접속 프로파일 식별자	보호 키 누락 시 기존 값으로 채워서 테스트

정상 응답

연결 성공

{
  "result": true
}

연결 실패

연결에 실패하더라도 HTTP 상태 코드 200을 반환하며, result 필드와 실패 사유를 함께 응답합니다.

{
  "result": false,
  "msg": "Connection refused"
}

result (불리언): 연결 성공 여부
msg (문자열): 연결에 실패한 경우의 오류 메시지

오류 응답

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

HTTP 상태 코드 400 응답

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

권한이 없는 경우

HTTP 상태 코드 500 응답

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