데이터베이스 API 레퍼런스

GIIP 플랫폼에 등록된 데이터베이스 자산의 정보를 조회하고 모니터링하기 위한 API 상세 명세입니다.

🔌 데이터베이스 관리 기능 페이지로 이동 →

📋 개요

데이터베이스 API를 통해 GIIP가 관리하는 MariaDB, Azure SQL, MySQL 등의 인스턴스 정보를 프로그래밍 방식으로 가져올 수 있습니다. 모든 요청에는 [API 레퍼런스 개요]에서 발급받은 AK/SK가 필요합니다.

🔍 주요 엔드포인트

1. 데이터베이스 목록 조회

등록된 모든 DB 인스턴스의 기본 정보를 가져옵니다.

URL: GET /database/list
주요 파라미터:
- csn (Integer): 고객 번호 필터링
- prj_isn (Integer): 특정 프로젝트 소속 DB만 조회

응답 예시:

{
  "RstVal": 1,
  "Data": [
    { "isn": 101, "db_name": "Prod_DB", "engine": "AzureSQL", "status": "Running" }
  ]
}

2. DB 성능 지표 조회

특정 DB의 실시간 또는 과거 성능 데이터를 조회합니다.

URL: GET /database/metrics
필수 파라미터: db_isn (DB 고유 번호)
응답 데이터: CPU 사용률, 데이터 입출력(IOPS), 여유 공간 등

3. 현재 연결 세션 조회

DB에 접속 중인 실시간 세션 목록을 가져옵니다.

URL: GET /database/sessions
용도: 특정 IP에서의 과도한 커넥션 발생 여부 확인

🛠️ 활용 예시 (Python)

import requests

headers = {"x-giip-ak": "YOUR_AK"}
response = requests.get("https://api.giip.io/v3/database/list", headers=headers)
db_list = response.json()["Data"]

for db in db_list:
    print(f"DB: {db['db_name']} | Status: {db['status']}")

🛡️ Sk3(고성능 로깅) 활용

데이터베이스 자산 데이터 전송의 무결성을 보장하고 상세한 호출 이력을 남기려면 giipApiSk3 엔드포인트를 사용하는 것이 좋습니다.

엔드포인트: https://giipfaw.azurewebsites.net/api/giipApiSk3
장점: 에이전트 에러 자동 감지, 호출자 IP 및 세션 정보 자동 기록, 복잡한 DB 쿼리 파라미터 전달 최적화.
활용 팁: text 명령과 jsondata를 함께 사용하여 필터링 조건이 많은 DB 목록 조회나 성능 지표 수집 시 데이터 유실 없이 안전하게 전송할 수 있습니다.

문제 해결

증상	원인	해결
401 인증 오류가 반환됨	`x-giip-ak` 헤더가 없거나 잘못된 AK/SK 사용	발급받은 유효한 AK/SK를 요청 헤더에 포함했는지 확인합니다.
`/database/metrics` 응답이 비어 있음	필수 파라미터 `db_isn` 누락	DB 고유 번호(`db_isn`)를 반드시 전달합니다.
`RstVal`이 1이 아닌 값으로 반환됨	`csn`/`prj_isn` 형식 오류 또는 권한 부족	파라미터를 정수형으로 전달하고 API 결과 코드 가이드를 확인합니다.
Sk3 호출 시 `jsondata` 파싱 실패	JSON 이스케이프/인코딩 오류	`jsondata`를 유효한 JSON으로 이스케이프하여 전송합니다.

버전: 1.1 최종 업데이트: 2026-04-10 소스 파일: giipv3/public/help/api-database.ko.md

관련 문서:

API 결과 코드 가이드 (RstVal)

← PreviousDatabase Management Back to OverviewKnowledge Center