접속 프로파일 생성

새 접속 프로파일을 생성합니다.

필요 권한

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

HTTP 요청

POST /api/sonar/connect-profiles

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

요청 매개변수

키	필수	타입	설명	비고
guid	X	문자열	접속 프로파일 GUID	36자. 기본값은 무작위 생성
code	O	문자열	접속 프로파일 이름	최소 1자, 최대 50자
type	O	문자열	접속 프로파일 유형	예: `jdbc`
name	O	문자열	접속 프로파일 화면 표시 이름	최소 1자, 최대 50자
description	X	문자열	접속 프로파일 설명	최대 2,000자
grant_users	X	문자열	권한 부여된 계정 GUID 목록	여러 개의 항목은 쉼표(`,`)로 구분
grant_groups	X	문자열	권한 부여된 계정 그룹 GUID 목록	여러 개의 항목은 쉼표(`,`)로 구분
configs	O	문자열 키/값	설정 값	JSON 형식 문자열

Tip

접속 프로파일 이름(code)은 parse 명령어 등 쿼리에서 참조하는 이름으로 사용됩니다.

정상 응답

{}

오류 응답

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

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": "duplicated profile code: testdb"
}

관리 권한이 없는 경우

HTTP 상태 코드 500 응답

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