접속 프로파일 목록 조회
사용 가능한 접속 프로파일 목록을 조회합니다.
HTTP 요청
GET /api/sonar/connect-profiles
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
"https://HOSTNAME/api/sonar/connect-profiles?offset=0&limit=20"
요청 매개변수
키 | 필수 | 타입 | 설명 | 비고 |
---|---|---|---|---|
offset | X | 32비트 정수 | 건너뛸 갯수 | 기본값 0 |
limit | X | 32비트 정수 | 최대 갯수 | 기본값 2147483647 |
type | X | 문자열 | 접속 프로파일 유형 | 지정된 유형만 검색 |
keywords | X | 문자열 | 검색 키워드 | code, name, description 대상으로 검색 |
company_guid | X | 문자열 | 회사 GUID | 클러스터 관리자의 경우 특정 회사로 결과 한정 |
정상 응답
{
"total_count": 1,
"profiles": [
{
"guid": "b7f00412-8720-4a8f-ac35-7d7f359f797e",
"code": "build",
"name": "빌드서버 SSH",
"type": "ssh",
"description": "",
"company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
"company_name": "로그프레소",
"configs": {
"password": "",
"port": 22,
"host": "build",
"server_alive_interval": null,
"user": "logpresso",
"timeout": 30
},
"config_description": "호스트: build, 포트: 22, 계정: xeraph, 인증 방식: 암호, 타임아웃: 30초",
"factory_display_name": "SSH",
"created": "2022-09-01 00:39:35+0900",
"updated": "2022-09-01 00:39:35+0900",
"grant_users": [
{
"type": "USER",
"guid": "bfd00bb0-be99-4fd5-8380-166f544975fa",
"name": "홍길동",
"read_only": true,
"created": "2022-09-02 19:38:21+0900"
}
],
"grant_groups": [
{
"type": "USER",
"guid": "28c1251b-2f7c-4c58-95a1-fc4a1ead877e",
"name": "dev",
"read_only": true,
"created": "2022-09-02 19:38:21+0900"
}
],
"protected_keys": ["password"]
}
]
}
- total_count (32비트 정수): 검색 조건과 일치하는 전체 접속 프로파일 수
- profiles (배열): 검색 조건과 일치하는 접속 프로파일 목록
- guid (문자열): 접속 프로파일 고유 식별자
- code (문자열): 쿼리용 식별자. 동일 접속 프로파일 유형 중 유일한 이름
- name (문자열): 접속 프로파일 화면 표시 이름
- type (문자열): 접속 프로파일 유형
- description (문자열): 접속 프로파일 설명
- company_guid (문자열): 접속 프로파일이 속한 회사의 고유 식별자
- company_name (문자열): 접속 프로파일이 속한 회사의 이름
- configs (맵): 접속 프로파일의 키/값 쌍.
password
처럼 보호 대상 설정은 원본 값을 반환하지 않고, 빈 문자열을 이용하여 설정이 되어있다는 사실만 반환합니다. - config_description (문자열): 접속 프로파일 설정 요약 정보. 목록에서 특정 접속 프로파일을 구분할 수 있는 핵심 정보를 표시합니다.
- factory_display_name (문자열): 접속 프로파일 유형의 화면 표시 이름. 예를 들어
jdbc
유형은 한글로데이터베이스
를 반환합니다. - created (문자열): 생성일시 (
yyyy-MM-dd HH:mm:ssZ
형식) - updated (문자열): 수정일시 (
yyyy-MM-dd HH:mm:ssZ
형식) - grant_users (배열): 접속 프로파일 사용 권한이 부여된 계정 목록
- type (문자열): 공유 객체 유형. 항상
USER
로 응답 - guid (문자열): 계정의 고유 식별자
- name (문자열): 사용자 성명
- read_only (불리언): 편집 가능 여부. 항상
false
로 응답 - created (문자열): 권한 매핑 생성 일시
- type (문자열): 공유 객체 유형. 항상
- grant_groups (배열): 접속 프로파일 사용 권한이 부여된 계정 그룹 목록
- type (문자열): 공유 객체 유형. 항상
USER
로 응답 - guid (문자열): 계정 그룹의 고유 식별자
- name (문자열): 계정 그룹의 이름
- read_only (불리언): 편집 가능 여부. 항상
false
로 응답 - created (문자열): 권한 매핑 생성 일시
- type (문자열): 공유 객체 유형. 항상
- protected_keys (배열): 보호되는 설정 키 이름의 목록. 예를 들어
password
설정은 조회 시 반환되지 않습니다.
오류 응답
offset, limit 값이 정수가 아닌 경우
HTTP 상태 코드 400
응답
{
"error_code": "invalid-argument",
"error_msg": "'offset' parameter should be int type"
}
offset, limit 값이 음수인 경우
HTTP 상태 코드 400
응답
{
"error_code": "invalid-argument",
"error_msg": "'offset' must be greater than or equal to 0."
}
식별자가 GUID 형식이 아닌 경우
HTTP 상태 코드 400
응답
{
"error_code": "invalid-param-type",
"error_msg": "company_guid should be guid type."
}