콘텐츠로 이동

Hub API

Hub API는 DADP 제어면의 공개 인터페이스다. 정책과 키 메타데이터를 정의하고, 연동 인스턴스를 등록하고, 엔진 상태와 운영 설정을 조회하거나 변경하는 작업이 이 경계에서 수행된다.

API 특성

  • 제어면 원본을 다룬다.
  • 운영자 또는 제어면 연동 클라이언트가 호출한다.
  • 암복호화 실행 경로를 직접 제공하지 않는다.
  • /api/v1/api/v2를 함께 사용한다.

대표 공개 리소스군

리소스군 대표 경로 역할
정책 /api/v1/policies 정책 생성, 조회, 수정, 버전 관리
키 메타데이터 /api/v1/keys 키 메타데이터 조회, 생성, 회전
마스킹 정책 /api/v1/mask-policies 마스킹 정책 관리
사용자와 역할 /api/v1/hub-users, /api/v1/roles Hub 사용자와 권한 관리
연동 인스턴스 /api/v2/instances Wrapper 등 연동 인스턴스 등록
스키마와 매핑 /api/v2/schemas, /api/v2/policy-mappings 스키마 동기화와 정책 매핑 관리
모니터링 /api/v1/monitoring Hub/Engine 상태 조회
알림 /api/v1/notifications 운영 알림 조회
설정 /api/v1/settings 운영 설정 조회와 저장
라이선스 및 신뢰 자산 /api/v1/license 연결형 환경의 검증과 복구 보조
UDF 설치 이력 /api/v1/udf/installations DB UDF 설치 이력 관리

버전 구분

/api/v1

운영자 중심의 제어면 API다. 정책, 키, 사용자, 역할, 설정, 모니터링처럼 Hub 자체 운영에 직접 연결되는 경로가 여기에 속한다.

/api/v2

연동 인스턴스와 스키마 매핑처럼 외부 실행 경로와 직접 연결되는 등록/동기화 API다. 인스턴스 식별과 스키마 식별을 분리해서 다루는 것이 핵심이다.

계약 해석

  • hubId, alias는 연동 인스턴스 축이다.
  • datasourceId는 스키마와 매핑 축이다.
  • 정책 원본은 Hub에 있고, 런타임 실행에 필요한 사본은 Engine 또는 연동 컴포넌트에 분배된다.

호출 예시 범주

작업 일반적인 흐름
정책 생성 정책 정의 작성 -> POST /api/v1/policies
키 회전 키 조회 -> 회전 요청 -> 새 버전 반영 확인
Wrapper 등록 인스턴스 등록 -> 데이터소스 등록 -> 스키마 동기화 -> 정책 매핑
운영 점검 모니터링/알림 API 조회 -> 필요 시 설정 조정

공개 범위에서 제외하는 것

다음 경로군은 현재 구현에 존재하더라도 공개 계약 문서의 중심으로 보지 않는다.

  • 내부 프록시용 경로
  • 테스트 또는 임시 운영용 경로
  • 폐기된 AOP 계열 경로

공개 문서는 고객이 장기적으로 의존할 제어면 표면만 유지한다.