API 인사이트에서 API 상세 정보 보기
엔터프라이즈 아키텍트는 작업 공간 내의 API 세부 정보 페이지에서 조직의 API 성능, 관계 및 거버넌스에 대한 인사이트를 얻을 수 있습니다 API 인사이트 .
API 상세 페이지에 대한 액세스 및 사용
API 상세 페이지에 액세스하려면 다음으로 이동하십시오. 에서 API 탭을 선택한 다음 API 데이터 테이블의 이름 열에서 API를 선택합니다.
데이터 보기
기본적으로 페이지에는 다음 데이터가 표시됩니다.
- 헤더 영역
- API 이름, 버전 정보, API의 현재 수명주기 스테이지(예: 운영 또는 수명 종료)를 표시합니다.
보기 기준 목록을 사용하면 API가 관리되는 여러 관리 플랫폼(사용 가능한 경우) 간에 전환할 수 있습니다.
버전 선택기를 사용하면 보고 관리할 다양한 버전의 API를 선택할 수 있습니다. 업데이트를 선택하여 선택한 버전에 따라 상세 정보를 업데이트합니다.
주:보기 기준 목록과 버전 선택기는 API에 적용할 수 있는 경우에만 나타납니다. - 메타데이터 영역
- 다음 필드를 표시합니다.
필드 설명 설명 API의 간략한 요약 또는 목적입니다. 마지막으로 검색됨 CMDB에서 API가 검색되거나 업데이트된 마지막 날짜. 디스커버리 소스 API가 검색된 소스입니다. 유형 API 유형(스크립트 REST API, HTTP API, 플랫폼 REST API 등)입니다. 소유권 그룹 API 관리를 담당하는 팀 또는 그룹입니다. 디지털 인터페이스 시스템 내 API의 상호작용 방법입니다. - 관련 목록
- 다음 항목을 개수와 함께 링크로 표시합니다.
항목 설명 액세스 요청 수신함 API에 대한 액세스 요청 수를 표시합니다. 카드에 표시된 링크를 선택하여 접근 요청 상세 정보를 봅니다. 소비자 API의 소비자 수를 표시합니다. 카드에 표시된 링크를 선택하여 각 API 소비자에 대한 상세 정보를 봅니다. 배치 환경 전반에서 API의 활성 또는 과거 배포를 나타냅니다. 카드에 표시된 링크를 선택하여 API 배포 상세 정보를 봅니다. 제품 API와 연결된 제품 수를 표시합니다. 카드에 표시된 링크를 선택하여 API 제품 상세 정보를 봅니다. 태그 API와 연결된 태그 수를 표시합니다. 카드에 표시된 링크를 선택하여 각 태그의 상세 정보를 봅니다. - 개요 패널
- 개요 패널 내에서 세 개의 하위 섹션으로 구성된 API의 사용 가능한 모든 구성요소를 나열합니다.
- 프런트엔드
- UI 또는 사용자 대면 기능과 상호 작용하는 GraphQL 변이 및 쿼리를 포함한 클라이언트 측 작업을 포함합니다.
- 백엔드
- 비즈니스 논리 및 데이터를 처리하는 백엔드 관련 GraphQL 변이 및 쿼리를 포함한 서버 측 작업을 포함합니다.
- 구성 요소
- 각각 API 내에서 특정 기능 또는 자원을 제공하는 다양한 REST API 엔드포인트 또는 서비스 인터페이스를 포함합니다.
각 하위 섹션을 확장하여 엔드포인트를 보고 엔드포인트를 선택하여 상세 정보를 볼 수 있습니다.
- 사용량
- 다음 카드를 표시합니다.
카드 설명 평균 요청 수 시간 경과에 따른 API 구성요소 요청 수로, 선 그래프로 표시되며 x축은 날짜 범위를 표시하고 y축은 요청 수를 표시합니다. 버전별 사용량 지난 10일 동안의 여러 버전에 걸친 API 요청 분포입니다. - 이벤트
- 다음 카드를 표시합니다.
카드 설명 심각 경보 API와 관련된 IT 운영의 중요 경보를 통해 API의 성능에 영향을 줄 수 있는 주요 문제를 식별할 수 있습니다. 카드를 선택하여 모든 오픈 경보를 표시하고 경보에 대한 자세한 정보에 액세스합니다.서비스 운영 작업 공간 자세한 내용은 Service Operations Workspace 문서를 참조하십시오.
인시던트 운영 상태 및 정정 노력을 추적하는 데 필수적인 API와 관련된 중단, 변경 요청 또는 문제와 같은 기록된 인시던트입니다. 카드를 선택하여 모든 미해결 인시던트를 표시하고 해당 인시던트에 대한 자세한 정보에 액세스합니다.서비스 운영 작업 공간 자세한 내용은 Service Operations Workspace 문서를 참조하십시오.
- 보안
- 다음 카드를 표시합니다.
카드 설명 활성 취약성 항목 잠재적 위험을 추적하고 해결할 수 있게 하는 API와 관련된 보안 취약성입니다. 카드를 선택하여 모든 취약성을 취약성 관리자 작업 공간 표시하고 취약성에 대한 자세한 정보에 액세스합니다. 자세한 내용은 Vulnerability Manager Workspace 문서를 참조하십시오.
보안 인시던트 보안 인시던트(활성화된 경우)는 API에서 발생할 수 있는 보안 위반 또는 문제에 대한 인사이트를 제공합니다. 카드를 선택하여 모든 미해결 보안 인시던트를 표시하고 해당 인시던트에 대한 자세한 정보에 액세스합니다.보안 인시던트 응답 작업 공간 자세한 내용은 Security Incident Response Workspace 문서를 참조하십시오.
- 관계 맵
- 구성요소, 관리 플랫폼, 비즈니스 애플리케이션 및 설계와의 API 관계에 대한 계층적 개요를 제공하여 광범위한 시스템 아키텍처 내에서 API의 역할을 더 쉽게 이해할 수 있도록 합니다. 또한 애플리케이션 서비스 관계를 관리하는 옵션을 제공합니다. API에 대한 애플리케이션 서비스 관계 관리 문서를 참조하십시오.
관계 맵은 에서 사용되는 것과 유사한 부분 통합 맵입니다.CMDB 작업 공간 API에 대한 통합 맵을 열려면 API 상세 페이지의 관계 맵 섹션에서 전체 맵 열기 를 선택합니다. 자세한 내용은 통합 맵 문서를 참조하십시오.
그림 2. API에 대한 통합 맵 - API에 대한 통합 맵에서 다음 요소를 사용할 수 있습니다.
- 1: 지도
- 맵에 지정된 API와 해당 연결 및 관계가 표시됩니다. 이 예에서 httpbin.org-v1.1 은 홈 노드이고 선은 다른 구성요소와의 연결 및 관계를 나타냅니다. 관련 애플리케이션 서비스, 변경 이력과 같은 상세 정보를 보려면 노드를 선택합니다.
- 2: 컨텐츠 통제
-
- 홈 노드를 검색하여 선택하고, 표시할 애플리케이션 서비스의 관계 수준 수를 지정하고, 변경한 후 맵을 다시 로드합니다.
- 필터를 사용하여 맵에 나타나는 유형 및 관계 유형을 제한합니다.
- 선택한 API에 대한 이벤트(관련 항목) 타임라인을 표시하거나 숨깁니다.
- 3: 도구 상자
- 도구 상자를 사용하여 확대/축소 수준 또는 레이아웃 모드와 같은 맵의 여러 시각적 측면을 제어합니다.
- 4: 상황별 측면 패널
-
- 속성 패널(
에는 선택한 API 또는 관계에 대한 위치 및 운영 상태와 같은 속성이 나열됩니다. - 애플리케이션 서비스 패널(
)에는 선택한 API와 연결된 애플리케이션 서비스의 상세 정보가 나열됩니다. - 관련 항목 패널(
에는 선택한 API에 대한 활성 인시던트 또는 활성 문제와 같은 관련 항목이 표시됩니다. - 변경 패널(
)에는 선택한 API의 운영 상태 변경과 같은 변경 사항이 나열됩니다.
- 속성 패널(
- 5 : 미니맵 네비게이터
- 확대/축소 수준을 설정하거나 뷰를 관심 영역으로 이동합니다. 네비게이터를 표시하거나 숨길 아이콘을 선택합니다.
- 6: 타임라인
- 타임라인은 지정된 기간 동안 선택한 API의 인시던트, 문제 및 변경 사항과 같은 이벤트(관련 항목)를 나타냅니다. 타임라인을 사용하여 API의 변경 이력과 API 토폴로지 CMDB에 미치는 영향을 시각화할 수 있습니다.