최신 API 정보는 Data Infrastructure Insights 에 로그인하여 관리자 > API 액세스*로 이동하면 확인할 수 있습니다. *API 문서 링크를 클릭하세요.

API 문서는 Swagger 기반으로, API에 대한 간략한 설명과 사용 정보를 제공하며 테넌트에서 사용해 볼 수 있도록 해줍니다. 사용자 역할 및/또는 Data Infrastructure Insights 에디션에 따라 사용할 수 있는 API 유형이 다를 수 있습니다.

Data Infrastructure Insights API를 사용하기 전에 하나 이상의 *API 액세스 토큰*을 만들어야 합니다. 액세스 토큰은 지정된 API 유형에 사용되며 읽기 및/또는 쓰기 권한을 부여할 수 있습니다. 각 액세스 토큰의 만료일을 설정할 수도 있습니다. 지정된 유형의 모든 API는 액세스 토큰에 유효합니다. 각 토큰에는 사용자 이름이나 비밀번호가 없습니다.

액세스 토큰을 생성하려면:

토큰을 비활성화, 활성화 및 취소할 수 있습니다. 비활성화된 토큰을 활성화할 수 있습니다.

토큰은 고객 관점에서 API에 대한 일반적인 액세스 권한을 부여하고, 자체 테넌트 범위 내에서 API에 대한 액세스를 관리합니다. 고객 관리자는 Data Infrastructure Insights 백엔드 직원의 직접적인 개입 없이 이러한 토큰을 부여하거나 취소할 수 있습니다.

사용자가 성공적으로 인증하고 액세스를 승인하면 애플리케이션은 액세스 토큰을 받은 다음 대상 API를 호출할 때 액세스 토큰을 자격 증명으로 전달합니다. 전달된 토큰은 토큰 보유자가 API에 액세스하고 권한 부여 시 부여된 범위에서 지정된 특정 작업을 수행할 권한이 있음을 API에 알립니다.

액세스 토큰이 전달되는 HTTP 헤더는 *X-CloudInsights-ApiKey:*입니다.

예를 들어, 다음을 사용하여 저장소 자산을 검색합니다.

사용하려는 API에 대한 구체적인 예는 Swagger 페이지를 참조하세요.

Data Infrastructure Insights API는 범주 기반이며 현재 다음 유형을 포함합니다.

시간이 지남에 따라 추가 유형 및/또는 API가 제공될 수 있습니다. 최신 API 정보는 다음에서 확인할 수 있습니다."API Swagger 문서" .

사용자가 액세스할 수 있는 API 유형은 다음에 따라서도 달라집니다."사용자 역할" 각 Data Infrastructure Insights 기능 세트(모니터링, 워크로드 보안, 보고)에 포함되어 있습니다.

이 섹션에서는 Data Infrastructure Insights 개체의 계층 구조를 탐색하는 방법을 설명합니다.

많은 API 명령은 expand 매개변수를 지원하는데, 이 매개변수는 객체에 대한 추가 세부 정보나 관련 객체의 URL을 제공합니다.

일반적인 확장 매개변수는 _expands_입니다. 응답에는 해당 객체에 대해 사용 가능한 모든 특정 확장 목록이 포함되어 있습니다.

예를 들어, 다음을 요청하는 경우:

각 확장에는 데이터, URL 또는 둘 다 포함됩니다. expand 매개변수는 다음과 같이 여러 개의 중첩된 속성을 지원합니다.

이를 방지하기 위해 최상위 컬렉션에 대한 요청은 확장될 수 없습니다. 예를 들어, 모든 저장소 개체에 대한 확장 데이터를 한 번에 요청할 수는 없습니다. 클라이언트는 객체 목록을 검색한 다음 확장할 특정 객체를 선택해야 합니다.

성능 데이터는 여러 장치에서 별도의 샘플로 수집됩니다. 매시간(기본값) Data Infrastructure Insights 성능 샘플을 집계하고 요약합니다.

API를 사용하면 샘플과 요약된 데이터에 모두 액세스할 수 있습니다. 성능 데이터가 있는 객체의 경우 성능 요약은 _expand=performance_로 사용할 수 있습니다. 성과 내역 시계열은 중첩된 _expand=performance.history_를 통해 사용할 수 있습니다.

성능 데이터 객체의 예는 다음과 같습니다.

성과 지표에는 설명과 유형이 있으며 성과 요약 모음이 포함되어 있습니다. 예를 들어, 지연 시간, 트래픽, 속도 등입니다.

성과 요약에는 설명, 단위, 샘플 시작 시간, 샘플 종료 시간, 그리고 단일 성과 카운터에서 시간 범위(1시간, 24시간, 3일 등)에 걸쳐 계산된 요약 값(현재, 최소, 최대, 평균 등) 모음이 포함됩니다.

그 결과 생성된 성능 데이터 사전에는 다음과 같은 키가 있습니다.

각 성능 데이터 개체 유형에는 고유한 성능 측정항목 세트가 있습니다. 예를 들어, 가상 머신 성능 개체는 성능 지표로 "diskThroughput"을 지원합니다. 지원되는 각 성능 지표는 지표 사전에 제시된 특정 "성능 범주"에 속합니다. Data Infrastructure Insights 이 문서의 뒷부분에 나열된 여러 가지 성능 지표 유형을 지원합니다. 각 성과 지표 사전에는 이 성과 지표에 대한 사람이 읽을 수 있는 설명인 "설명" 필드와 성과 요약 카운터 항목 세트도 있습니다.

성능 요약 카운터는 성능 카운터의 요약입니다. 카운터의 최소값, 최대값, 평균값과 같은 일반적인 집계 값을 표시하고, 요약 데이터의 경우 최신 관찰값, 시간 범위, 카운터의 단위 유형, 데이터의 임계값을 표시합니다. 임계값만 선택 사항이고 나머지 속성은 필수 사항입니다.

다음 유형의 카운터에 대한 성능 요약을 사용할 수 있습니다.

API는 테넌트의 개체에 대한 자세한 메트릭을 반환할 수 있습니다. 예:

를 참조하십시오"API Swagger 문서" 각 개체 유형에 대한 메트릭에 대한 정보입니다.

성능 데이터에는 기록 데이터가 타임스탬프와 카운터 맵 쌍의 목록으로 표시됩니다.

기록 카운터는 성능 측정 항목 개체 이름을 기반으로 이름이 지정됩니다. 예를 들어, 가상 머신 성능 개체는 "diskThroughput"을 지원하므로 기록 맵에는 "diskThroughput.read", "diskThroughput.write" 및 "diskThroughput.total"이라는 키가 포함됩니다.

다음은 디스크의 성능 데이터 JSON의 예입니다.

용량 속성이 있는 객체는 기본 데이터 유형과 CapacityItem을 사용하여 표현합니다.

검색 API는 시스템에 대한 간단한 진입점입니다. API에 대한 유일한 입력 매개변수는 자유형 문자열이고, 그 결과로 생성되는 JSON에는 분류된 결과 목록이 포함됩니다. 유형은 저장소, 호스트, 데이터 저장소 등 인벤토리의 다양한 자산 유형입니다. 각 유형에는 검색 기준과 일치하는 유형의 객체 목록이 포함됩니다.

Data Infrastructure Insights 타사 오케스트레이션, 비즈니스 관리, 변경 제어 및 티켓팅 시스템은 물론 맞춤형 CMDB 통합을 허용하는 확장 가능한(광범위한) 솔루션입니다.

Cloud Insight의 RESTful API는 데이터를 간단하고 효과적으로 이동할 수 있게 해주는 주요 통합 지점이며, 사용자가 데이터에 원활하게 액세스할 수 있게 해줍니다.

API 토큰을 일시적으로 비활성화하려면 API 토큰 목록 페이지에서 해당 API의 "세 개의 점" 메뉴를 클릭하고 _비활성화_를 선택합니다. 언제든지 동일한 메뉴에서 _활성화_를 선택하여 토큰을 다시 활성화할 수 있습니다.

API 토큰을 영구적으로 제거하려면 메뉴에서 "철회"를 선택하세요. 취소된 토큰은 다시 활성화할 수 없습니다. 새 토큰을 만들어야 합니다.

API 액세스 토큰에는 만료일이 있습니다. API 액세스 토큰이 만료되면 사용자는 새 토큰(읽기/쓰기 권한이 있는 데이터 수집 유형)을 생성하고 만료된 토큰 대신 새로 생성된 토큰을 사용하도록 Telegraf를 재구성해야 합니다. 아래 단계에서는 이를 수행하는 방법을 자세히 설명합니다.