접속 프로파일 연결 테스트

접속 프로파일을 생성하기 전에 연결 설정의 유효성을 동기 방식으로 테스트합니다. 연결에 성공하면 result 값이 true, 실패하면 false와 실패 원인을 담은 msg가 반환됩니다. 비동기 방식의 테스트는 접속 프로파일 테스트 API를 사용합니다.

필요 권한

게스트 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -G \
     --data-urlencode 'type=jdbc' \
     --data-urlencode 'configs={"connection_string":"jdbc:mysql://198.51.100.1:3306/testdb","user":"admin","password":"secret"}' \
     https://HOSTNAME/api/sonar/connect-profiles/test-connect

요청 매개변수

configs의 키는 프로파일 유형별로 다릅니다. 유형별로 지원하는 설정 항목은 접속 프로파일 설정 항목 조회 API로 확인할 수 있습니다.

정상 응답

연결에 성공한 경우:

{
  "result": true
}

연결에 실패한 경우:

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

• result (불리언): 연결 성공 여부
• msg (문자열): 연결 실패 원인. 연결에 실패한 경우에만 포함됩니다.

오류 응답

type이 누락된 경우

HTTP 상태 코드 400 응답

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

configs가 누락된 경우

HTTP 상태 코드 400 응답

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