서버 관리 API 가이드 (v1.2)

GIIP 플랫폼의 핵심 자산인 논리 머신(LSVR)을 등록하고 관리하기 위한 API 가이드입니다.

🔌 서버 목록 기능 페이지로 이동 →

📋 개요

서버 관리 API를 통해 인프라 내의 서버 자산 정보를 조회하고, 신규 서버를 플랫폼에 등록하여 모니터링 대상으로 편입시킬 수 있습니다.

🔐 인증 및 보안

• Header: x-giip-ak / x-giip-sk 헤더를 통한 인증 필수

📡 API 상세

1. 서버 목록 조회 (LSVRList)

• 명령:

  text=LSVRList <CSN>

• 설명: 지정된 프로젝트(CSN)에 속한 모든 서버 목록을 반환합니다.
• 예시:

  text=LSVRList 44

2. 서버 상세 정보 조회 (LSVRDetail)

• 명령:

  text=LSVRDetail <id>

• 파라미터:

  id

  는 내부 일련번호(LSSN), 호스트명, 또는 고유 키(kKey)일 수 있습니다.
• 예시:

  text=LSVRDetail my-prod-server

3. 논리 머신(LSVR) 신규 등록 (LSvrPut)

• 명령:

  text=LSvrPut '<lsUsage>', <CSN>

• 파라미터:

  • lsUsage

    : 서버 용도 및 설명 (예: 'Web_Frontend_Server')

  • CSN

    : 소속 프로젝트 식별자
• 주의사항:
  • 용도 설명에 공백이 포함된 경우 언더스코어로 자동 변환될 수 있습니다.
  • 문자열 내 작은따옴표는

    ''

    로 이스케이프해야 합니다.

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

신규 서버 등록(

LSvrPut

)이나 상세 정보 변경(

LSVRDetail

을 통한 검증) 등 인프라 자산 관리의 핵심 작업 시, 작업의 정합성 확보와 상세한 감사 로그(Audit Log)를 위해

giipApiSk3

엔드포인트를 권장합니다.

• 엔드포인트:

  https://giipfaw.azurewebsites.net/api/giipApiSk3

• 장점: 서버 등록 실패 시 호출자의 상세 환경 정보(IP, UA)와 StackTrace를 즉시 기록하여 에이전트 연동 문제나 설정 오류를 신속하게 분석할 수 있습니다.
• 활용 팁:

  text

  명령과

  jsondata

  의 파라미터 치환 기능을 활용하여 서버 용도(

  lsUsage

  )나 복잡한 설정값들을 유실 없이 안정적으로 플랫폼에 반영하십시오.

---

버전: 1.3 최종 업데이트: 2026-04-10 소스 파일:

giipv3/public/help/api-server.ko.md

---

관련 문서:

• API 결과 코드 가이드 (RstVal)