๋ชจ๋ํฐ๋ง ๋ฐ์ดํฐ ์กฐํ API ๋ ํผ๋ฐ์ค
์๋ฒ ๋ฐ ๋ฐ์ดํฐ๋ฒ ์ด์ค์ ์ค์๊ฐ ์ฑ๋ฅ ๋ฉํธ๋ฆญ๊ณผ ๊ฐ์ฌ ๋ก๊ทธ๋ฅผ ํ๋ก๊ทธ๋๋ฐ ๋ฐฉ์์ผ๋ก ์ถ์ถํ๋ API๋ฅผ ์๋ดํฉ๋๋ค.
๐ ๊ฐ์
์ด API ๋ชจ๋์ GIIP ์์ด์ ํธ๊ฐ ์์งํ ๋ฐฉ๋ํ ์ฑ๋ฅ ๋ฐ์ดํฐ๋ฅผ ์ธ๋ถ ์์คํ (Grafana, ELK ๋ฑ)์ผ๋ก ์ฐ๋ํ๊ฑฐ๋ ๋ถ์ํ๊ธฐ ์ํ ์ธํฐํ์ด์ค๋ฅผ ์ ๊ณตํฉ๋๋ค.
๐ ์ธ์ฆ ๋ฐ ํค๋
๋ชจ๋ ์์ฒญ์ ๊ณตํต ์ธ์ฆ ํค๋๋ฅผ ํฌํจํด์ผ ํฉ๋๋ค.
- Header:
x-giip-ak: [Your Access Key] - Header:
x-giip-sk: [Your Secret Key]
๐ ์ฃผ์ API ์๋ํฌ์ธํธ
1. ์ค์๊ฐ ์๋ฒ ๋ฉํธ๋ฆญ ์กฐํ (Get Real-time Metrics)
- URL:
POST /api/monitoring/server/current - ์ค๋ช : ํน์ ์๋ฒ์ ๊ฐ์ฅ ์ต์ ์ฑ๋ฅ ์ํ(CPU, MEM, Disk)๋ฅผ ์กฐํํฉ๋๋ค.
- Request Body:
{
"serverIsn": 456
}
2. ์ฑ๋ฅ ์ด๋ ฅ ์กฐํ (Get Metric History)
- URL:
POST /api/monitoring/server/history - ์ค๋ช : ํน์ ๊ธฐ๊ฐ ๋์์ ์ฑ๋ฅ ๋ณํ ์ถ์ด ๋ฐ์ดํฐ๋ฅผ ์๊ณ์ด๋ก ๋ฐํํฉ๋๋ค.
- Request Body:
{
"serverIsn": 456,
"startTime": "2026-03-19T00:00:00Z",
"endTime": "2026-03-19T23:59:59Z",
"interval": "5m"
}
3. ํ๋ก์ธ์ค ๋ชฉ๋ก ์กฐํ (Get Process List)
- URL:
POST /api/monitoring/server/processes - ์ค๋ช : ์๋ฒ์์ ํ์ฌ ์คํ ์ค์ธ ์ ์ฒด ํ๋ก์ธ์ค ๋ชฉ๋ก๊ณผ ์์ ์ ์ ์จ์ ์กฐํํฉ๋๋ค.
- Request Body:
{
"serverIsn": 456
}
๐ ์๋ต ๋ฐ์ดํฐ ์์ (Metrics)
{
"RstVal": 0,
"RstMsg": "Success",
"Data": {
"cpuUsage": 12.5,
"memUsage": 45.2,
"diskUsage": 68.1,
"networkIn": 1024,
"networkOut": 512
}
}
๐ก ํ์ฉ ์ฌ๋ก
- ์ปค์คํ ๋์๋ณด๋: ํ์ฌ ๋ด๋ถ์ ํตํฉ ๊ด์ ๋์๋ณด๋์ GIIP์ ์ค์๊ฐ ๋ฐ์ดํฐ๋ฅผ ์๋ฒ ๋ฉํฉ๋๋ค.
- ์ด์ ์งํ ๋ถ์: ์ฑ๋ฅ ์ด๋ ฅ API๋ก ๋ฐ์ดํฐ๋ฅผ ์ถ์ถํ์ฌ ๋จธ์ ๋ฌ๋ ๋ชจ๋ธ์ ์ ๋ ฅํ๊ณ ์ฅ์ ๋ฅผ ์์ธกํฉ๋๋ค.
๐ก๏ธ Sk3(๊ณ ์ฑ๋ฅ ๋ก๊น ) ํ์ฉ
๊ณ ๋น๋์ ๋ชจ๋ํฐ๋ง ๋ฐ์ดํฐ ์์ง์ด๋ ๋๋์ ์๊ณ์ด ์ฑ๋ฅ ์งํ ์กฐํ ์, ๋ฐ์ดํฐ ์ ์ก์ ๋ฌด๊ฒฐ์ฑ๊ณผ ์ ๊ตํ ์๋ฌ ์ถ์ ์ ์ํด giipApiSk3 ์๋ํฌ์ธํธ๋ฅผ ๊ถ์ฅํฉ๋๋ค.
- ์๋ํฌ์ธํธ:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - ์ฅ์ : ๋๋์ ๋ฉํธ๋ฆญ ๋ฐ์ดํฐ๋ฅผ
jsondata๋ก ์ ์กํ ๋ ๋ฐ์ํ ์ ์๋ ๋ฐ์ดํฐ ์๋ฆผ ๋ฐฉ์ง ๋ฐ ์๋ฌ ์ ์์ด์ ํธ ์ธก์ ์์ธ ๋ก๊ทธ๋ฅผ ์๋ ์์งํ์ฌ ๋ฐ์ดํฐ ์์ง ํ์ดํ๋ผ์ธ์ ์ ๋ขฐ์ฑ์ ๋ณด์ฅํฉ๋๋ค. - ํ์ฉ ํ:
startTime,endTime,interval๋ฑ์ ๋ณต์กํ ์กฐํ ์กฐ๊ฑด์jsondata์ ๋ด์ Sk3๋ฅผ ํธ์ถํ๋ฉด ์ฟผ๋ฆฌ ํ๋ผ๋ฏธํฐ ์ ์ค ์์ด ์์ ํ๊ฒ ํต๊ณ ๋ฐ์ดํฐ๋ฅผ ํ๋ณดํ ์ ์์ต๋๋ค.
๋ฌธ์ ํด๊ฒฐ
| ์ฆ์ | ์์ธ | ํด๊ฒฐ |
|---|---|---|
| ์ธ์ฆ ์คํจ (RstVal์ด 0์ด ์๋) | x-giip-ak ๋๋ x-giip-sk ํค๋ ๋๋ฝยท์คํ | ๋ ํค๋๋ฅผ ๋ชจ๋ ์ ํจํ ํค ๊ฐ์ผ๋ก ํฌํจํ์ฌ ์ฌ์์ฒญ |
| ์๋ต ๋ฐ์ดํฐ๊ฐ ๋น์ด ์์ | ์์ฒญ Body์ serverIsn ๊ฐ์ด ์๋ชป๋์๊ฑฐ๋ ์ซ์๊ฐ ์๋ | ๋์ ์๋ฒ์ ์ฌ๋ฐ๋ฅธ serverIsn(์ซ์)์ ์ง์ |
| ์ฑ๋ฅ ์ด๋ ฅ ์กฐํ ๊ฒฐ๊ณผ ์์ | startTimeยทendTime์ด ISO8601(์: 2026-03-19T00:00:00Z) ํ์์ด ์๋๊ฑฐ๋ ๊ธฐ๊ฐ์ด ์ญ์ ๋จ | ์ฌ๋ฐ๋ฅธ ์๊ฐ ํ์๊ณผ startTime < endTime์ ํ์ธํ๊ณ interval(์: 5m)์ ์ง์ |
| ๋๋ ์กฐํ ์ ๋ฐ์ดํฐ๊ฐ ์๋ฆผ | ์ผ๋ฐ ์๋ํฌ์ธํธ๋ก ๋๋ jsondata๋ฅผ ์ ์ก | giipApiSk3 ์๋ํฌ์ธํธ๋ก ์ ํํ์ฌ ๋ฐ์ดํฐ ์์ค ๋ฐฉ์ง |
๋ฒ์ : 1.1
์ต์ข
์
๋ฐ์ดํธ: 2026-04-10
์์ค ํ์ผ: giipv3/public/help/api-monitoring.ko.md
๊ด๋ จ ๋ฌธ์: