이슈 관리 API 레퍼런스
GIIP 플랫폼에서 발생하는 이슈 및 에러 로그를 프로그래밍 방식으로 조회하고 상태를 업데이트하는 API를 안내합니다.
📋 개요
이 API 모듈은 실시간 이슈 관리 솔루션인 [이슈 관리] 메뉴의 데이터를 외부 시스템과 동기화하거나, 장애 대응 파이프라인(ITSM 등)과 연동하기 위해 사용됩니다.
🔐 인증 및 헤더 (Authentication)
모든 요청은 유효한 **Secret Key (SK)**를 포함해야 합니다.
- Header:
x-api-key: [Your_SK] - Header:
x-giip-sk: [Your_SK] - Body:
(JSON 요청 시){ "token": "[Your_SK]" } - Query:
?token=[Your_SK]
🚀 주요 API 엔드포인트 (실제 구현 기준)
1. 이슈 전용 엔드포인트 (REST API)
가장 직관적인 호출 방식입니다.
- 목록 조회:
GET /api/giipIssues?status=READY - 상세 조회:
GET /api/giipIssues?isn=7890 - 상태 업데이트:
또는POST /api/giipIssuesPUT /api/giipIssues- Body:
{ "isn": "7890", "status": "DONE", "comment": "처리 완료" }
- Body:
2. 범용 API 래퍼 (giipApiSk2)
GIIP의 Stored Procedure를 직접 호출하는 방식이며, AI 에이전트 권장 방식입니다.
- URL:
POST /api/giipApiSk2 - Body (Form-data/JSON):
:token[Your_SK]
:text[Command] [Params...]
주요 명령어 예시:
: READY 상태 이슈 조회GiipIssueList READY
: 7890번 이슈 상세 조회GiipIssueGet 7890
: 7890번 이슈 완료 처리GiipIssuePut 7890 DONE
🔍 응답 데이터 예시
{ "RstVal": 0, "RstMsg": "Success", "Data": [ { "issueIsn": 7890, "severity": "Critical", "subject": "Disk Usage 95% on Web-01", "regDate": "2026-03-19T14:20:00Z" } ] }
💡 활용 사례
- 슬랙 알림 봇: API를 주기적으로 호출하여 신규
이슈 발생 시 즉시 개발팀 채널에 메시지를 보냅니다.Critical - 자동 복구 스크립트: 특정 유형의 이슈(예: 프로세스 다운) 탐지 시 API로 이슈를 확인하고, 원격 명령 API(
)를 호출하여 해당 서비스를 재시작합니다.api-system
🛡️ Sk3(고성능 로깅) 활용
장애 대응 시스템이나 외부 티켓팅 도구와의 연동 시, 업데이트 무결성 보장과 상세한 호출 이력 추적을 위해
giipApiSk3 엔드포인트를 권장합니다.
- 엔드포인트:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - 장점: 이슈 상태 업데이트(Done 처리 등) 실패 시 호출자의 상세 환경 정보(IP, UA)와 StackTrace를 즉시
에 기록하여 장애 대응 프로세스의 신뢰성을 높여줍니다.tErrorLogs - 활용 팁:
치환 기능을 사용하여 이슈 내의 특정 변수값이나 긴 에러 메시지를 파라미터 유실 없이 안전하게 전송할 수 있습니다.jsondata
버전: 1.2 최종 업데이트: 2026-05-03 소스 파일:
giipv3/public/help/giip-issue-api.ko.md
관련 문서: