메타성 정보 조회
프로젝트 목록 조회
GET https://api.whatap.io/open/api/json/projects
command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/projects"
response
{
"data": [ {
"groupName": "",
"projectCode": 35,
"projectName": "APM_TEST2",
"createTime": "2018-10-19 07:17:03.774",
"status": "subscribe",
"productType": "APM",
"platform": "JAVA",
"gatewayName": "LOCAL",
"apiToken": "5**********************R"
}, {
}, (...)
],
"accountEmail": "xxx@whatap.io",
"total": 6
}
| Response Field | Field Type | 설명 |
|---|---|---|
| gourpName | string | 프로젝트 상위 그룹 이름 |
| projectCode | number | 프로젝트 코드 |
| projectName | string | 프로젝트 이름 |
| createTime | string | 프로젝트 생성 날짜 |
| lastUpdatedTime | string | 프로젝트 수정 날짜 |
| status | string | 프로젝트 상태 |
| productType | string | 애플리케이션 서버 유형 |
| platform | string | 애플리케이션 서버 플랫폼 |
| gatewayName | string | 게이트웨이 이름 |
| apiToken | string | PROJECT API TOKEN |
| accountEmail | string | 사용자 계정 이메일 주소 |
| total | number | 프로젝트 수 |
프로젝트 정보 조회
GET https://api.whatap.io/open/api/json/project
노트
이 기능은 애플리케이션 모니터링 상품군에 해당합니다.
command
$ curl -L -w "\n" -H "x-whatap-token: {{PROJECT API TOKEN}}" -H "x-whatap-pcode: {{projectCode}}" "https://api.whatap.io/open/api/json/project"
response
{
"platform": "JAVA",
"createTime": "Tue Sep 18 08:34:27 GMT 2018",
"gatewayName": "Office-OTE",
"projectCode": 1**1,
"status": "Subscribe",
"lastUpdatedTime": "Tue Sep 18 08:34:34 GMT 2018",
"name": "SEO_APM",
"productType": "APM"
}
| Response Field | Field Type | 설명 |
|---|---|---|
| platform | string | 애플리케이션 서버 플랫폼 |
| createTime | string | 프로젝트 생성 날짜 |
| projectCode | number | 프로젝트 코드 |
| status | string | 프로젝트 상태 |
| lastUpdatedTime | string | 프로젝트 수정 날짜 |
| productType | string | 애플리케이션 서버 유형 |
프로젝트 정보 및 상세 서버 조회
GET https://api.whatap.io/open/api/json/projects
노트
이 기능은 서버 모니터링 상품군에 해당합니다.
command
$ curl -L -w "\n" -H "x-whatap-token: {{PROJECT API TOKEN}}" -H "x-whatap-pcode: {{projectCode}}" "https://api.whatap.io/open/api/json/project"
response
{
"pname":"LOCAL_PC",
"timezone":9,
"regionName":"LOCAL",
"values":{
"servers":[
{
"public_ip":"192.168.1.0",
"os_cpuvendor":"Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz",
"agent_created":"1572406071216",
"ip":"192.168.1.0",
"os_arch":"amd64",
"actTime":1572406264112,
"cpu_cores":"8",
"oid":-1030311093,
"isActive":true,
"okind":"",
"version":"1.2.4",
"tags":[
"network:169.254.0.0/16",
"network:192.168.1.0/24",
"java",
"OpenVpn",
"oracle",
"ftp"
],
"inactTime":0,
"oname":"DESKTOP-KEIPLT5",
"os_name":"windows",
"startTime":1572406263602,
"os_memory":"17036419072",
"os_status":"warning"
},
(...)
],
}
}
프로젝트 에이전트 상태 및 호스트 조회
GET https://api.whatap.io/open/json/agents
command
$ curl -L -w "\n" -H "x-whatap-token: {{PROJECT API TOKEN}}" -H "x-whatap-pcode: {{projectCode}}" "https://api.whatap.io/open/json/agents"
response
{
"data":[
{
"host_ip":"127.0.0.1",
"oname":"TC-29-96-8082",
"active":true
}, {
} (...)
]
}
프로젝트 멤버 목록 조회
GET https://api.whatap.io/open/api/json/project/projectCode/members
command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/project/{{projectCode}}/members"
response
{
"data": [ {
"email": "honggildong@whatap.io",
"name": "홍길동",
"typeKey": "super_admin",
"typeName": "Super Admin"
}, {
}, (...)
],
"total": 6
}
| Response Field | Field Type | 설명 |
|---|---|---|
| string | 사용자 계정 이메일 주소 | |
| name | string | 사용자 계정 이름 |
| typeKey | string | 사용자 권한 |
| typeName | string | 사용자 권한 명칭 |
| total | number | 프로젝트 멤버 수 |
그룹 목록 조회
GET https://api.whatap.io/open/api/json/groups
command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/v2/json/groups"
response
{
"data": [ {
"groupName": "WHATAP APM",
"groupKey": "grp****ab123kskd*****q",
"description": "APM Group"
}, {
}, (...)
],
"total": 3
}
그룹 멤버 목록 조회
GET https://api.whatap.io/open/api/json/group/groupKey/members
command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/group/{{groupKey}}/members"
response
{
"data": [ {
"groupName": "WHATAP APM",
"groupKey": "AB123KSKD*****2uasQ",
"description": "APM Group"
}, {
}, (...)
],
"total": 3
}
그룹에 포함된 프로젝트 조회
GET https://api.whatap.io/open/api/json/group/groupKey/projects
그룹에 포함된 프로젝트들의 메타정보를 조회하는 API 입니다. 계정의 API Token 이 필요하며 curl 을 사용한 예시 요청은 아래에 있습니다.
command
$ curl -L -w "\n" -H "x-whatap-token: {{ACCOUNT API TOKEN}}" "https://api.whatap.io/open/api/json/group/{{groupKey}}/projects"
response
{
"data": [
{
"projectCode":35,
"name":"APM_TEST2",
"status":"Subscribe",
"productType":"APM",
"platform":"JAVA",
"gatewayName":"LOCAL"
}, {
}, (...)
]
}
| Response Field | Field Type | 설명 |
|---|---|---|
| projectCode | number(integer) | 프로젝트 코드 |
| name | string | 프로젝트 명 |
| status | string | 프로젝트 상태 (pending, trial, subscribe, close_pending, limited, closed, trial_limited) |
| productType | string | 프로젝트에 사용된 상품 |
| platform | string | 프로젝트에 사용된 상품의 플랫폼 |
| gatewayName | string | 데이터 서버 지역 |
oid 목록 호출
사용자가 조회를 원하는 시간 동안 활성화된 에이전트 정보를 조회할 수 있습니다.
POST https://api.whatap.io/open/api/v2/agent/list
request
curl --location 'https://api.whatap.io/open/api/v2/agent/list' -H 'x-whatap-token: {{PROJECT API TOKEN}}
' -H 'x-whatap-pcode: {{projectCode}}' -d '{"stime":1690850183000,"etime":1693321200000}'
response
{
"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
},
...
]
}
노트
-
이 문서에서 작성된 샘플 코드 중
stime,etime파라미터 값은 사용자 환경에 맞게 변경해 이용하세요. 파라미터 값은 다양한 포맷으로 요청할 수 있습니다.- 1693475430087 (unix timestamp)
yyyyMMddHHmmssyyyyMMddHHmmMMddHHmmssMMddHHmm
-
조회 시간(
stime,etime)은 하루로 제한하며, ms(millisecond) 단위 입니다.