에서 API 상세 정보 보기 API 인사이트

  • 릴리스 버전: Zurich
  • 업데이트 날짜 2025년 07월 31일
  • 소요 시간: 4분
  • 엔터프라이즈 아키텍트는 작업 공간 내의 API 세부 정보 페이지에서 조직의 API 성능, 관계 및 거버넌스에 대한 인사이트를 얻을 수 있습니다 API 인사이트 .

    작업 공간의 API 상세 정보 페이지에서는 API 인사이트 API의 운영 상태, 사용량, 보안 및 내부 관계 CMDB에 대한 자세한 뷰를 제공합니다.
    그림 1. API 상세 정보 페이지
    작업 공간의 API 인사이트 API 상세 정보 페이지
    .

    API 상세 정보 페이지 액세스 및 사용

    API 세부 정보 페이지에 액세스하려면 다음으로 이동합니다. 작업 공간 > API 인사이트, API 탭을 선택한 다음 API 테이블의 이름 열에서 API를 선택합니다.

    데이터 보기

    기본적으로 페이지에는 다음 데이터가 표시됩니다.

    헤더 영역
    API 이름, 버전 정보, API의 현재 수명주기 스테이지(예: 운영 또는 수명 종료)를 표시합니다.

    보기 기준 목록을 사용하면 API가 관리되는 여러 관리 플랫폼(사용 가능한 경우) 간에 전환할 수 있습니다.

    버전 선택기를 사용하면 보고 관리할 API의 다른 버전을 선택할 수 있습니다. 업데이트를 선택하여 선택한 버전에 따라 세부 정보를 업데이트합니다.

    주:
    보기 기준 목록과 버전 선택기는 API에 해당하는 경우에만 나타납니다.
    메타데이터 영역
    다음 필드를 표시합니다.
    필드 설명
    설명 API의 간략한 요약 또는 목적입니다.
    마지막으로 검색됨 에서 CMDBAPI가 검색되거나 업데이트된 마지막 날짜입니다.
    디스커버리 소스 API가 검색된 소스입니다.
    유형 스크립팅된 REST API, HTTP API, 플랫폼 REST API 등 API의 유형입니다.
    소유권 그룹 API 관리를 담당하는 팀 또는 그룹입니다.
    디지털 인터페이스 시스템 내 API의 상호작용 메서드입니다.
    관련 목록
    다음 필드를 표시합니다.
    필드 설명
    액세스 요청 수신함 API에 대한 액세스 요청 수를 표시합니다. 카드에 표시된 번호를 선택하여 액세스 요청 상세 정보를 봅니다.
    소비자 API의 소비자 수를 표시합니다.
    배치 환경 전반에 걸친 API의 활성 또는 과거 배포를 나타냅니다.
    개요 패널
    API의 사용 가능한 모든 작업(엔드포인트)을 나열합니다. 상세 정보를 보려면 엔드포인트를 선택합니다.
    사용량
    다음 필드를 표시합니다.
    필드 설명
    일일 요청 시간 경과에 따른 API 구성요소 요청 수로, 선 그래프로 표시되며, x축은 날짜 범위를 표시하고 y축은 요청 수를 표시합니다.
    버전별 요청(지난 10일) 지난 10일 동안 여러 버전 간의 API 요청 분포입니다.
    비즈니스 애플리케이션 디지털 인터페이스 기록에 반영된 대로 API 설계에 연결된 비즈니스 애플리케이션이라고도 하는 비즈니스 컨텍스트 의 수입니다.
    보안
    다음 필드를 표시합니다.
    필드 설명
    활성 취약성 항목 잠재적 위험을 추적하고 해결할 수 있는 API와 관련된 보안 취약성입니다.
    보안 인시던트 보안 인시던트(활성화된 경우)는 API에서 발생했을 수 있는 보안 위반 또는 문제에 대한 인사이트를 제공합니다.
    이벤트
    다음 필드를 표시합니다.
    필드 설명
    심각 경보 API와 관련된 IT 운영의 중요 경보를 통해 API의 성능에 영향을 줄 수 있는 주요 문제를 식별할 수 있습니다.
    인시던트 운영 상태 및 정정 노력을 추적하는 데 필수적인 중단, 변경 요청 또는 API와 관련된 문제와 같은 기록된 인시던트입니다.
    관계 맵
    구성요소, 관리 플랫폼 , 비즈니스 애플리케이션 및 설계와의 API 관계에 대한 계층적 개요를 제공하여 광범위한 시스템 아키텍처 내에서 API의 역할을 보다 쉽게 이해할 수 있도록 합니다. 또한 애플리케이션 서비스 관계를 관리하는 옵션을 제공합니다. API에 대한 애플리케이션 서비스 관계 관리 문서를 참조하십시오.

    관계 맵은 에서 CMDB 작업 공간사용된 것과 비슷한 부분 통합 맵입니다. API에 대한 통합 맵을 열려면 API 세부 정보 페이지의 관계 맵 섹션에서 전체 맵 열기 를 선택합니다. 자세한 내용은 문서를 참조하십시오.

    그림 2. API에 대한 통합 맵
    API 통합 맵
    맵의 노드는 API를 나타내고 및 줄의 CMDB 해당 구성요소는 API 구성요소 간의 연결 및 관계를 나타냅니다. 예를 들어, 연결은 관계와 참조를 통해 연결된 구성요소를 표시함으로써 선택한 노드에 대한 변경의 영향을 평가하는 데 도움이 됩니다. , Incident ManagementEvent Management 같은 Change Management제품은 이러한 정보의 이점을 누릴 수 있습니다.

    또한 이 맵은 및 Incident Management와 같은 Event Management 제품에 유용한 애플리케이션 서비스의 구성을 보여줍니다. 변경 내역을 검토할 수 있습니다.

    API에 대한 통합 맵에서 사용할 수 있는 요소는 다음과 같습니다.
    1: 지도
    맵에 지정된 API와 해당 연결 및 관계가 표시됩니다. 이 예에서 httpbin.org-v1.1 은 홈 노드이고 선은 다른 구성 요소와의 연결 및 관계를 나타냅니다. 노드를 선택하여 관련 애플리케이션 서비스, 변경 이력과 같은 상세 정보를 봅니다.
    2: 콘텐츠 통제
    • 홈 노드를 검색 및 선택하고, 애플리케이션 서비스가 표시할 관계 수준의 수를 지정하고, 변경한 후 맵을 다시 로드합니다.
    • 필터를 사용하여 맵에 표시되는 유형과 관계 유형을 제한합니다.
    • 선택한 API에 대한 이벤트(관련 항목)의 타임라인을 표시하거나 숨깁니다.
    3: 도구 상자
    도구 상자를 사용하여 확대/축소 수준 또는 레이아웃 모드와 같은 맵의 여러 시각적 측면을 제어할 수 있습니다.
    4: 상황별 측면 패널
    • 속성 패널(속성 아이콘)에는 선택한 API 또는 관계에 대한 위치 및 운영 상태와 같은 속성이 나열됩니다.
    • 애플리케이션 서비스 패널( 애플리케이션 서비스 아이콘.)에는 선택한 API와 연결된 애플리케이션 서비스의 상세 정보가 나열됩니다.
    • 관련 항목 패널( 관련 항목 아이콘.)에는 선택한 API에 대한 활성 인시던트 또는 활성 문제와 같은 관련 항목이 표시됩니다.
    • 변경 패널( 변경 사항 아이콘. )에는 선택한 API에 대한 운영 상태 변경과 같은 변경 내용이 나열됩니다.
    5: 미니맵 네비게이터
    확대/축소 수준을 설정하거나 뷰를 관심 영역으로 이동합니다. 네비게이터를 표시하거나 숨길 아이콘을 선택합니다.
    6: 타임라인
    타임라인에는 지정된 기간 동안 선택한 API에 대한 인시던트, 문제 및 변경 내용과 같은 이벤트(관련 항목)가 표시됩니다. 타임라인을 사용하여 API에 대한 변경 내역과 이러한 변경 내역이 API의 토폴로지에 미치는 영향을 시각화할 수 있습니다 CMDB.