접속 프로파일 설정 명세 조회

지정한 접속 프로파일 유형의 설정 명세를 조회합니다. 조회 가능한 유형 목록은 접속 프로파일 유형 목록 조회 API로 확인할 수 있습니다.

필요 권한

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

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/connect-profile-types/jdbc/options

요청 매개변수

경로 매개변수

정상 응답

{
  "options": [
    {
      "type": "string",
      "subtype": "connection-string",
      "name": "connection_string",
      "required": true,
      "display_name": "연결 문자열",
      "description": "연결 문자열",
      "default_value": null,
      "min": null,
      "max": null,
      "protected": false
    },
    {
      "type": "string",
      "subtype": null,
      "name": "user",
      "required": false,
      "display_name": "계정",
      "description": "",
      "default_value": null,
      "min": null,
      "max": null,
      "protected": false
    },
    {
      "type": "string",
      "subtype": "password",
      "name": "password",
      "required": false,
      "display_name": "암호",
      "description": "",
      "default_value": null,
      "min": null,
      "max": null,
      "protected": true
    },
    {
      "type": "boolean",
      "subtype": null,
      "name": "read_only",
      "required": false,
      "display_name": "읽기 전용",
      "description": "읽기 전용",
      "default_value": "false",
      "min": null,
      "max": null,
      "protected": false
    }
  ]
}

• options (배열): 설정 명세 목록
  • type (문자열): 데이터 타입
  • subtype (문자열): UI에서 인식하는 확장 컴포넌트 유형. 해당 없으면 null
  • name (문자열): 설정 키
  • required (불리언): 필수 설정 여부
  • display_name (문자열): 로케일이 적용된 화면 표시 이름
  • description (문자열): 로케일이 적용된 화면 표시 설명
  • default_value (문자열): 화면에 표시할 설정 기본값. subtype이 enum인 경우 null로 응답되고, 선택 가능한 값은 selectable로 응답합니다.
  • selectable (문자열): subtype이 enum인 경우에만 응답합니다. 선택 가능한 값을 담습니다.
  • min (32비트 정수): 설정 값에 허용되는 최솟값. 해당 없으면 null
  • max (32비트 정수): 설정 값에 허용되는 최댓값. 해당 없으면 null
  • protected (불리언): 보호 설정 여부. password 등 접속 프로파일 조회 시 노출되면 안 되는 설정 항목은 true로 지정합니다.

오류 응답

프로파일 유형이 존재하지 않는 경우

HTTP 상태 코드 200 응답

{
  "options": null
}

권한이 없는 경우

HTTP 상태 코드 500 응답

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