접속 프로파일 테스트

지정한 접속 프로파일 설정으로 비동기 연결 테스트를 시작합니다. 백그라운드에서 테스트가 진행되며, 응답으로는 테스트 진행 상태 조회와 중단에 사용할 테스트 GUID만 즉시 반환됩니다. 실제 결과는 접속 프로파일 테스트 상태 조회로 폴링하여 확인하고, 필요하다면 접속 프로파일 테스트 중단으로 중단할 수 있습니다.

이 API는 정식 등록 직전의 본격 검증 용도이며, 정식 등록과 동일하게 code, type, name, configs 등 필수 매개변수를 모두 요구합니다. 폼 입력 중 빠르게 연결 가능 여부만 확인하려면 동기식인 접속 프로파일 연결 테스트를 사용하세요.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d code=testdb \
     -d type=jdbc \
     -d name="Hyper SQL" \
     -d description="Embedded file database" \
     -d configs="{""connection_string"":""jdbc:hsqldb:file:testdb"", ""user"":""SA"", ""password"":null, ""read_only"":false}" \
     -X POST \
     https://HOSTNAME/api/sonar/connect-profiles/test

요청 매개변수

정상 응답

{
  "guid": "f2e4c1d3-9b21-4f0a-8de7-5b3a91f8c6a2"
}

• guid (문자열): 진행 중인 접속 프로파일 테스트의 GUID. 이후 상태 조회 및 중단 요청에 사용

오류 응답

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

HTTP 상태 코드 400 응답

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

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

HTTP 상태 코드 400 응답

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

필수 설정 값이 누락된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "config option must be not null: connection_string"
}

접속 프로파일 유형이 잘못된 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "profile type not found: invalid-type"
}

권한이 없는 경우

HTTP 상태 코드 500 응답

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