MENU
      Cloud Insight 개요

        Cloud Insight 개요


        기사 요약

        Classic/VPC 환경에서 이용 가능합니다.

        Cloud Insight는 네이버 클라우드 플랫폼이 제공하는 서비스들의 성능 지표를 통합 관리하고, 장애 발생 시 담당자에게 장애 정보를 신속히 전달할 수 있는 네이버 클라우드 플랫폼의 서비스입니다. Cloud Insight 서비스에서는 Schema, Plugin, Event Rule, Planned Maintenance 등의 기능에 대한 API를 RESTful 형태로 제공합니다.

        Cloud Insight 지표

        Cloud Insight API를 통해 네이버 클라우드 플랫폼 서비스(상품)의 성능/운영 지표(Metric)를 통합 관리하고 다양한 모니터링에 활용할 수 있습니다. 성능/운영 지표를 제공하는 네이버 클라우드 플랫폼 서비스(상품) 정보와 성능/운영 지표에 대한 자세한 설명은 다음을 참조해 주십시오.

        • Metric, Dimension, Aggregation, Schema 등 개념에 대한 설명: Cloud Insight 개념
        • 네이버 클라우드 플랫폼 서비스별(상품별) 성능/운영 지표 정보 확인: Cloud Insight 지표

        Cloud Insight 공통 설정

        Cloud Insight API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

        요청

        공통 요청 형식을 설명합니다.

        API URL

        요청 API URL은 다음과 같습니다.

        https://cw.apigw.ntruss.com
        HTTP

        요청 헤더

        헤더에 대한 설명은 다음과 같습니다.

        필드필수 여부설명
        x-ncp-apigw-timestampRequired1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
        • API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
        • Unix Timestamp 형식
        x-ncp-iam-access-keyRequired네이버 클라우드 플랫폼에서 발급받은 Access Key
        x-ncp-apigw-signature-v2Required네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
        Content-typeOptional요청 데이터의 형식
        • application/json
        x-ncp-region_codeOptional네이버 클라우드 플랫폼 리전 코드
        • KR | SGN | JPN | USWN | DEN
          • KR: 한국 리전
          • SGN: 싱가포르 리전
          • JPN: 일본 리전
          • USWN: 미국 서부 리전
          • DEN: 독일 리전
        x-ncp-dmn_cdOptional네이버 클라우드 플랫폼 도메인 정보

        응답

        공통 응답 형식을 설명합니다.

        응답 상태 코드

        Cloud Insight API는 네이버 클라우드 플랫폼의 공통 응답 상태 코드를 사용합니다. 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

        Cloud Insight API

        Cloud Insight 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

        Dashboard

        Dashboard 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        GetDashboardList대시보드 목록 조회
        GetDashboardWidgetImage대시보드 위젯 이미지 파일 다운로드
        GetDashboardWidgetList대시보드 위젯 목록 조회

        Event

        Event 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        SearchEventEvent 검색 및 조회
        SearchEventByIdEvent 아이디 및 Rule 아이디로 Event 상세 조회
        SearchEventCountConsoleEvent 발생 횟수 조회

        Event Rule

        Event Rule 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        CopyRuleGroupEvent Rule 복사
        CreateMetricsGrpRule Template(감시 항목 그룹) 생성
        CreateMonitorGrp감시 대상 그룹 생성
        CreateRuleDirectly감시 대상과 감시 항목을 직접 지정하여 Event Rule 생성
        CreateRuleGroupEvent Rule 생성
        DeleteMetricGroupForce특정 Rule Template(감시 항목 그룹)과 관련된 전체 Event Rule 삭제
        DeleteMetricsGrpRule Template(감시 항목 그룹) 삭제
        DeleteMetricsGrpByProdKeyAndIdRule Template 아이디로 Rule Template(감시 항목 그룹) 삭제
        DeleteMonitorGroupForce특정 감시 대상 그룹과 관련된 전체 Event Rule 삭제
        DeleteMonitorGrp감시 대상 그룹 삭제
        DeleteRuleGroupEvent Rule 삭제
        DeleteRuleGroupByProdKeyAndIdEvent Rule 아이디로 Event Rule 삭제
        GetAllMonitorGrp감시 대상 그룹 목록 조회
        GetMetricsGroup특정 Rule Template(감시 항목 그룹)의 상세 정보 조회
        GetMetricsGroupListRule Template(감시 항목 그룹) 목록 조회
        GetMonitorGrp특정 감시 대상 그룹의 상세 정보 조회
        GetNotificationRecipientList통보 대상 조회
        GetRuleGroup특정 Event Rule의 상세 정보 조회
        GetRuleGroupByMetricGroupIdsRule Template(감시 항목 그룹)과 관련된 Event Rule 조회
        GetRuleGroupByMonitorGroupIds감시 대상 그룹과 관련된 Event Rule 조회
        GetRuleGroupListEvent Rule 목록 조회
        RemoveResourceFromRulesEvent Rule의 감시 대상 그룹에서 특정 감시 대상 삭제
        SearchMetricList감시 대상 그룹에서 조회 가능한 감시 항목 조회
        UpdateMetricsGroupRule Template(감시 항목 그룹) 수정
        UpdateMonitorGrp감시 대상 그룹 수정
        UpdateRuleGroupEvent Rule 수정

        Schema

        Schema 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        CreateCustomSchema사용자 정의 스키마 생성
        DeleteProductSchema사용자 정의 스키마 삭제
        GetExtendedStatus인스턴스의 Extended Metric 설정 조회
        GetProductSchema사용자 정의 스키마 조회
        GetSystemSchemaKeyList스키마의 상품 키(cw_key) 조회
        RegisterProductSchema사용자 정의 스키마 등록
        UpdateExtendedDisable인스턴스의 Extended Metric 수집 설정 해제
        UpdateExtendedEnable인스턴스의 Extended Metric 수집 설정
        UpdateProductSchema사용자 정의 스키마 수정

        Custom Resource

        Custom Resource 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        CreateCustomResource사용자 정의 리소스 생성
        DeleteCustomResource사용자 정의 리소스 삭제
        GetAllCustomResource사용자 정의 리소스 목록 조회
        GetCustomResource특정 사용자 정의 리소스의 상세 정보 조회
        UpdateCustomResource사용자 정의 리소스 수정

        Planned Maintenance

        Planned Maintenance 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        CreatePlannedMaintenance유지 보수 일정 생성
        DeletePlannedMaintenance유지 보수 일정 삭제
        GetPlannedMaintenanceDetailById특정 유지 보수 일정의 상세 조회
        GetPlannedMaintenanceList유지 보수 일정 목록 조회
        UpdatePlannedMaintenance유지 보수 일정 수정

        Plugin

        Plugin 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        AddFilePluginFile Plugin 추가
        AddPortPluginPort Plugin 추가
        AddProcessPluginProcess Plugin 추가
        GetAllFilePluginFile Plugin 목록 조회
        GetAllPortPluginPort Plugin 목록 조회
        GetAllProcessPluginProcess Plugin 목록 조회
        GetFilePlugin특정 인스턴스에 대한 File Plugin 조회
        GetPortPlugin특정 인스턴스에 대한 Port Plugin 조회
        GetProcessPlugin특정 인스턴스에 대한 Process Plugin 조회
        RemoveFilePluginFile Plugin 삭제
        RemovePortPluginPort Plugin 삭제
        RemoveProcessPluginProcess Plugin 삭제
        UpdateFilePluginFile Plugin 설정 변경
        UpdatePortPluginPort Plugin 설정 변경
        UpdateProcessPluginProcess Plugin 설정 변경

        Server

        Server 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        GetServersTopCPU, 메모리, 파일 시스템 사용률이 높은 상위 5개 서버 조회

        Data

        Data 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        SendDataCloud Insight로 JSON 데이터 전송
        QueryDataCloud Insight에 저장된 time-series 데이터 조회
        QueryDataMultipleCloud Insight에 저장된 time-series 데이터 다중 조회
        QueryWidgetDataPreviewMetric을 지정하여 위젯 미리 보기 데이터 조회

        Integration

        Integration 관련 API에 대한 설명은 다음과 같습니다.

        API설명
        CreateIntegrationIntegration 생성
        DeleteIntegrationIntegration 삭제
        GetIntegrationIntegration 조회
        GetIntegrationListIntegration 목록 조회
        UpdateIntegrationIntegration 업데이트

        Cloud Insight 연관 리소스

        Cloud Insight API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.


        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.