수집 중인 모니터링 정보를 추출하여 별도로 활용하고자 하는 경우 Open API를 통해 해당 정보를 추출할 수 있는 기능을 제 공합니다. 계정 API 토큰 및 프로젝트 API 토큰, 프로젝트 코드를 파라미터로 전달하여 수집된 정보를 획득할 수 있습니다.
구 버전의 Open API 문서는 다음 문서를 참조하세요.
토큰은 계정 API 토큰과 프로젝트 API 토큰으로 구분됩니다. 계정 API 토큰은 프로젝트의 목록 정보를 취득하기 위한 용도로, 프로젝트 API 토큰은 프로젝트의 모니터링 정보를 취득하기 위한 용도로 활용합니다.
프로젝트 코드는 프로젝트 진입 시 브라우저 화면 상단의 윈도우 또는 탭 제목에 '[{프로젝트 코드}] Cloud Application Monitoring'와 같이 표시되는 정보를 통해 확인할 수 있습니다. API 토큰을 변경하려면 각 화면의 재발급 또는 토큰 재발급 버튼을 선택하세요.
| 구분 | 키 | 설정값 | 비교 |
|---|---|---|---|
| 헤더 | x-whatap-token |
API토큰 | 계정 API토큰 |
| 헤더 | x-whatap-token |
API토큰 | 프로젝트 API토큰 |
| 헤더 | x-whatap-pcode |
프로젝트 코드 | 화면 윈도우 또는 브라우저 탭 타이틀 확인 |
화면의 오른쪽 위에 프로필 아이콘을 선택하세요.
팝업 메뉴가 나타나면 계정 관리 버튼을 선택하세요.
화면을 아래로 스크롤해 API토큰 섹션으로 이동하세요.
홈 화면에서 프로젝트를 선택하세요.
프로젝트 진입 후 왼쪽에 관리 > 프로젝트 관리 메뉴를 선택하세요.
API토큰 항목을 확인하세요.
프로젝트 목록을 조회하는 API입니다.
| x-whatap-token required | string 계정 API 토큰 {{ACCOUNT_API_TOKEN}} |
Array of objects | |
| accountEmail | string 사용자 계정 이메일 주소 |
| total | integer 프로젝트 수 |
curl -L \ -w "\n" \ -H "Content-Type: application/json" \ -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \ "https://api.whatap.io/open/api/json/projects"
{- "data": [
- {
- "projectCode": 35,
- "projectName": "APM_TEST2",
- "createTime": "2018-10-19T07:17:03.774",
- "status": "subscribe",
- "productType": "APM",
- "platform": "JAVA",
- "apiToken": "5**********************R"
}
], - "accountEmail": "xxx@whatap.io",
- "total": 6
}애플리케이션 및 서버 제품의 프로젝트 정보를 조회하는 API입니다.
| x-whatap-token required | string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}} |
| x-whatap-pcode required | string 프로젝트 코드 {{projectCode} |
| platform | string 애플리케이션 제품 플랫폼 |
| createTime | string 프로젝트 생성 날짜 |
| gatewayName | string 데이터 서버 지역 |
| projectCode | number 프로젝트 코드 |
| status | string Enum: "pending" "trial" "subscribe" "close_pending" "limited" "closed" "trial_limited" 프로젝트 상태 |
| lastUpdatedTime | string 프로젝트 수정 날짜 |
| name | string 프로젝트 이름 |
| productType | string 애플리케이션 제품 유형 |
curl -L \ -w "\n" \ -H "Content-Type: application/json" \ -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \ -H "x-whatap-pcode: {{projectCode}}" \ "https://api.whatap.io/open/api/json/project"
{- "platform": "JAVA",
- "createTime": "Tue Sep 18 08:34:27 GMT 2018",
- "gatewayName": "Office-OTE",
- "projectCode": 1234,
- "status": "Subscribe",
- "lastUpdatedTime": "Tue Sep 18 08:34:34 GMT 2018",
- "name": "SEO_APM",
- "productType": "APM"
}프로젝트에 소속된 멤버 목록을 조회하는 API입니다.
| projectCode required | integer 프로젝트 코드 |
| x-whatap-token required | string 계정 API 토큰 {{ACCOUNT_API_TOKEN}} |
Array of objects | |
| total | integer 프로젝트 멤버 수 |
curl -L \ -w "\n" \ -H "Content-Type: application/json" \ -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \ "https://api.whatap.io/open/api/json/project/{projectCode}/members"
{- "data": [
- {
- "email": "honggildong@whatap.io",
- "name": "홍길동",
- "desc": "",
- "sms": "010XXXXXXX"
}
], - "totla": 8
}사용자가 소속된 그룹 목록을 조회하는 API입니다.
| x-whatap-token required | string 계정 API 토큰 {{ACCOUNT_API_TOKEN}} |
Array of objects | |
| total | integer 그룹 수 |
curl -L \ -w "\n" \ -H "Content-Type: application/json" \ -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \ "https://api.whatap.io/open/api/v2/json/groups"
{- "data": [
- {
- "groupName": "WHATAP APM",
- "groupKey": "grp****ab123kskd*****q",
- "description": "APM Group"
}
], - "total": 3
}사용자가 소속된 그룹의 멤버 목록을 조회하는 API입니다.
| groupKey required | integer 그룹 고유 식별자(ID) |
| x-whatap-token required | string 계정 API 토큰 {{ACCOUNT_API_TOKEN}} |
Array of objects | |
| total | integer 그룹 멤버 수 |
curl -L \ -w "\n" \ -H "Content-Type: application/json" \ -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \ "https://api.whatap.io/open/api/json/group/{groupKey}/members"
{- "data": [
- {
- "email": "honggildong@whatap.io",
- "name": "홍길동",
- "desc": "",
- "sms": "010XXXXXXX"
}
], - "totla": 8
}그룹에 포함된 프로젝트들의 메타정보를 조회하는 API입니다.
| groupKey required | integer 그룹 고유 식별자(ID) |
| x-whatap-token required | string 계정 API 토큰 {{ACCOUNT_API_TOKEN}} |
Array of objects | |||||||||||||
Array
| |||||||||||||
curl -L \ -w "\n" \ -H "Content-Type: application/json" \ -H "x-whatap-token: {{ACCOUNT_API_TOKEN}}" \ "https://api.whatap.io/open/api/json/group/{groupKey}/projects"
{- "data": [
- {
- "projectCode": 35,
- "name": "APM_TEST2",
- "status": "Subscribe",
- "productType": "APM",
- "platform": "JAVA",
- "gatewayName": "LOCAL"
}
]
}프로젝트 내 에어전트의 상태 및 IP 주소를 조회하는 API입니다.
| x-whatap-token required | string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}} |
| x-whatap-pcode required | string 프로젝트 코드 {{projectCode} |
Array of objects | |||||||
Array
| |||||||
curl -L \ -w "\n" \ -H "Content-Type: application/json" \ -H "x-whatap-token: {{PROJECT_API_TOKEN}}" \ -H "x-whatap-pcode: {{projectCode}}" \ "https://api.whatap.io/open/json/agents"
{- "data": [
- {
- "host_ip": "127.0.0.1",
- "oname": "TC-29-96-8082",
- "active": true
}
]
}사용자가 조회를 원하는 시간 동안 활성화된 에이전트 정보를 조회할 수 있는 API입니다. 조회 시간(stime, etime)은 하루로 제한되며, 시간 단위는 ms(millisecond, ms)입니다.
예시에서 작성된 샘플 코드 중 stime, etime 파라미터 값은 사용자 환경에 맞게 변경해 사용하세요. 파라미터 값은 다양한 포맷으로 변경해 요청할 수 있습니다.
yyyyMMddHHmmssyyyyMMddHHmmMMddHHmmssMMddHHmm| x-whatap-token required | string 프로젝트 API 토큰 {{PROJECT_API_TOKEN}} |
| x-whatap-pcode required | string 프로젝트 코드 {{projectCode} |
| stime | long 조회 시작 시간(UNIX epoch time, millisecond) |
| etime | long 조회 종료 시간(UNIX epoch time, millisecond) |
| stime | long 조회 시작 시간(UNIX epoch time, millisecond) |
| etime | long 조회 종료 시간(UNIX epoch time, millisecond) |
| timestamp | long 데이터 생성 시간(UNIX epoch time, millisecond) |
Array of objects |
{- "stime": 1690850183000,
- "etime": 1693321200000
}{- "stime": 1690850183000,
- "etime": 1693321200000,
- "timestamp": 1693388196965,
- "data": [
- {
- "oid": 757639646,
- "oname": "DBX-0-107-3306",
- "alias": "",
- "initial": "",
- "otype": "database",
- "subtype": "0",
- "active": false,
- "okind": 0,
- "okindName": "",
- "onode": 0,
- "onodeName": "",
- "ip": "",
- "agent.version": "",
- "cpuCores": 0
}
]
}