Open API 스펙
계정 API
프로젝트 목록 조회 등, 프로젝트의 권한 범위를 넘는 Open API의 경우 계정 API 토큰을 사용하여 호출합니다.
Open API 호출 시 헤더에 포함하는 내용은 다 음과 같습니다.
| 구분 | 키 | 설정값 | 비고 |
|---|---|---|---|
| 헤더 | x-whatap-token | API토큰 | 계정 API토큰: 화면 오른쪽 위 프로필 아이콘 선택 > 계정 관리 > API토큰 |
메타성 정보 조회용 OpenAPI로 호출할 수 있는 항목은 다음과 같습니다. Open API 호출 사용법은 다음 문서를 참조하세요.
- 프로젝트 목록 조회
- 프로젝트 멤버 목록 조회
- 사용자의 그룹 목록 조회
- 그룹 멤버 목록 조회
- 그룹에 포함된 프로젝트 조회
프로젝트 API
프로젝트 권한 범위 내의 Open API의 경우 프로젝트 코드와 함께 프로젝트 API 토큰을 사용하여 호출합니다.
Open API 호출 시 헤더에 포함하는 내용은 다음과 같습니다.
| 구분 | 키 | 설정 값 | 비고 |
|---|---|---|---|
| 헤더 | x-whatap-token | API토큰 | 프로젝트 API토큰: 프로젝트 선택 > 관리 > 프로젝트 관리 > API토큰 |
| x-whatap-pcode | 프로젝트 코드 | 화면 윈도우 또는 브라우저 탭 타이틀에서 확인[{프로젝트 코드}] Cloud Application Monitoring |
메타성 정보 조회
메타성 정보 조회용 OpenAPI로 호출할 수 있는 항목은 다음과 같습니다. Open API 호출 사용법은 다음 문서를 참조하세요.
- 프로젝트 정보 조회(애플리케이션 상품군)
- 프로젝트 정보 및 상세 서버 조회(서버 상품군)
- 프로젝트 에이전트 상태 및 호스트 조회
Spot 정보 조회
Spot 정보 조회용 Open API로 호출할 수 있는 항목은 다음과 같습니다. Open API 호출 사용법은 다음 문서를 참조하세요.
애플리케이션 상품군
- 활성화 상태의 에이전트 수
- 비활성화 상태의 에이전트 수
- 호스트 수
- 호스트의 CPU 코어 합
- 트랜잭션 수
- 초당 트랜잭션 수
- 5분간 집계된 고유 사용자 수
- 액티브 트랜잭션 수
- 평균 응답 시간
- CPU 사용률
- 스레드풀 활성 스레드 수
- 스레드풀 큐잉 스레드 수
- 전체 DB Connection 수
- 활성(Active) DB Connection 수
- 비활성(Idle) DB Connection 수
- 액티브 Method 수
- 액티브 SQL 수
- 액티브 HTTP Call 수
- 액티브 DB Connection 수
- 액티브 Socket 수
서버 상품군
- 활성화 상태의 에이전트 수
- 비활성화 상태의 에이전트 수
- 호스트 수
- 호스트의 CPU 코어 합
- CPU 사용률
- 디스크 IOPS 합계
- 네트워크 트래픽(IN/OUT) 합산
- 프로세스 현황
- 서버 목록
- 서버 모니터링 상세
- 서버 통계 상세
통계 정보 조회
통계 정보 조회용 OpenAPI는 시간 범위를 설정해 호출하며 URL에 다음 항목을 포함할 경우 동작 방식은 다음과 같습니다.
- 시간 범위 미지정 시 최근 5분간의 정보를 조회
stime: 조회 시작 시간 (UNIX epoch time, millisecond)etime: 조회 종료 시간 (UNIX epoch time, millisecond)
etime은 stime을 기준으로 1일을 초과할 수 없습니다.
- oids: agent 식별 ID입니다. 쉼표(,)를 구분자로 이용해 복수 설정할 수 있습니다.
- URL에 "/avg"를 포함하면 에이전트 단위의 평균치 도출을 의미합니다.
통계 정보 조회용 OpenAPI로 호출할 수 있는 항목은 다음과 같습니다. Open API 호출 사용법은 다음 문서를 참조하세요.
- Exception 발생
- HTTP 외부 호출
- Client IP
- SQL 발행
- 트랜잭션
- Thread 수
- Thread Daemon 수
- Thread Peak 수
- Thread Pool 수
- Thread Pool Queue 수
- 프로젝트 간 트랜잭션 호출 통계
- 도메인 호출 통계
- 액티브 사용자 (5분 단위)
- 액티브 사용자 (1시간 단위)
프로젝트 통계 조회
프로젝트 통계 조회용 Open API는 하나의 프로젝트에서 여러 에이전트를 통해 수집하는 데이터를 병합하여 조회합니다. 시간 범위를 설정하여 호출할 수 있습니다.
-
시간 범위를 설정하지 않으면 가장 최근의 데이터 조회
-
stime: 조회 시작 시간 (UNIX epoch time, millisecond) -
etime: 조회 종료 시간 (UNIX epoch time, millisecond)etime값만 주어진 경우etime시간 기준 5초 전 데이터 조회 -
timeMerge: 조회 시작 & 종료 시간 설정 시 시간 데이터 병합 전략 (평균:avg, 최대값:max, 최소값:min)
etime은stime을 기준으로 1일을 초과할 수 없습니다.stime은etime을 설정했을 경우timeMerge(시간 병합 전략)를 옵션으로 추가할 수 있습니다. 시간 병합 전략을 추가하지 않을 경우 기본 병합 전략은 평균입니다.
프로젝트 통계 조회용 OpenAPI로 호출할 수 있는 항목은 다음과 같습니다. Open API 호출 사용법은 다음 문서를 참조하세요.
- 프로젝트 내 TPS
- 프로젝트 내 평균 응답시간
- 프로젝트 내 평균 CPU 사용률
- 프로젝트 내 데이터 소스별 DB Connection 수
장기 통계 정보 조회
장기 통계 조회용 Open API는 유형에 따라 시간 설정 범위를 가집니다. 시간 범위를 설정해 호출하며 URL에 다음 항목을 포함하면 동작 방식은 다음과 같습니다.
stime: 조회 시작 시간 (UNIX epoch time, millisecond)etime: 조회 종료 시간 (UNIX epoch time, millisecond)
방문 사용자는 1일 단위 액티브 사용자 그리고 1개월 단위 액티브 사용자로 집계됩니다.
- 액티브 사용자(1일 단위):
etime은stime을 기준으로 31일을 초과할 수 없습니다. - 액티브 사용자(1개월 단위):
etime은stime을 기준으로 365일을 초과할 수 없습니다.
Open API 호출 사용법은 다음 문서를 참조하세요.
단기 조회
지정된 시간의 정보를 조회합니다. 시간을 설정하지 않을 경우 최근 데이터를 조회합니다. 프로젝트 단위로 조회하며 에이전트들의 데이터는 자동 병합됩니다. Query String(쿼리 문자열)을 사용합니다. 각 쿼리 문자열은 '&' 기호와 함께 연결해 사용할 수 있으며 사용 가능한 쿼리 문자열은 다음과 같습니다.
stime: 조회 시작 시간 (UNIX epoch time, millisecond)etime: 조회 종료 시간 (UNIX epoch time, millisecond)timeMerge: 시간 병합 설정으로avg,min,max,sum을 사용할 수 있습니다.
단기 조회용 Open API로 호출할 수 있는 항목은 다음과 같습니다. Open API 호출 사용법은 다음 문서를 참조하세요.
- 트랜잭션 수
- 평균 응답 시간
- 평균 cpu 사용률
- 활성/비활성 DB Connection 수