Cloud Insight 개요

Prev Next

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

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

  • Metric, Dimension, Aggregation, Schema 등 개념에 대한 설명: Cloud Insight 개념

  • 네이버 클라우드 플랫폼 서비스별(상품별) 성능/운영 지표 정보 확인: Cloud Insight 지표

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

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

API URL

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

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

요청 헤더

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

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

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

응답 상태 코드

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

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

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

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

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

API 설명
SearchEvent Event 검색 및 조회
SearchEventById Event 아이디 및 Rule 아이디로 Event 상세 조회
SearchEventCountConsole Event 발생 횟수 조회

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

API 설명
CopyRuleGroup Event Rule 복사
CreateMetricsGrp Rule Template(감시 항목 그룹) 생성
CreateMonitorGrp 감시 대상 그룹 생성
CreateRuleDirectly 감시 대상과 감시 항목을 직접 지정하여 Event Rule 생성
CreateRuleGroup Event Rule 생성
DeleteMetricGroupForce 특정 Rule Template(감시 항목 그룹)과 관련된 전체 Event Rule 삭제
DeleteMetricsGrp Rule Template(감시 항목 그룹) 삭제
DeleteMetricsGrpByProdKeyAndId Rule Template 아이디로 Rule Template(감시 항목 그룹) 삭제
DeleteMonitorGroupForce 특정 감시 대상 그룹과 관련된 전체 Event Rule 삭제
DeleteMonitorGrp 감시 대상 그룹 삭제
DeleteRuleGroup Event Rule 삭제
DeleteRuleGroupByProdKeyAndId Event Rule 아이디로 Event Rule 삭제
GetAllMonitorGrp 감시 대상 그룹 목록 조회
GetMetricsGroup 특정 Rule Template(감시 항목 그룹)의 상세 정보 조회
GetMetricsGroupList Rule Template(감시 항목 그룹) 목록 조회
GetMonitorGrp 특정 감시 대상 그룹의 상세 정보 조회
GetNotificationRecipientList 통보 대상 조회
GetRuleGroup 특정 Event Rule의 상세 정보 조회
GetRuleGroupByMetricGroupIds Rule Template(감시 항목 그룹)과 관련된 Event Rule 조회
GetRuleGroupByMonitorGroupIds 감시 대상 그룹과 관련된 Event Rule 조회
GetRuleGroupList Event Rule 목록 조회
RemoveResourceFromRules Event Rule의 감시 대상 그룹에서 특정 감시 대상 삭제
SearchMetricList 감시 대상 그룹에서 조회 가능한 감시 항목 조회
UpdateMetricsGroup Rule Template(감시 항목 그룹) 수정
UpdateMonitorGrp 감시 대상 그룹 수정
UpdateRuleGroup Event Rule 수정

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

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

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

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

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

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

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

API 설명
AddFilePlugin File Plugin 추가
AddPortPlugin Port Plugin 추가
AddProcessPlugin Process Plugin 추가
GetAllFilePlugin File Plugin 목록 조회
GetAllPortPlugin Port Plugin 목록 조회
GetAllProcessPlugin Process Plugin 목록 조회
GetFilePlugin 특정 인스턴스에 대한 File Plugin 조회
GetPortPlugin 특정 인스턴스에 대한 Port Plugin 조회
GetProcessPlugin 특정 인스턴스에 대한 Process Plugin 조회
RemoveFilePlugin File Plugin 삭제
RemovePortPlugin Port Plugin 삭제
RemoveProcessPlugin Process Plugin 삭제
UpdateFilePlugin File Plugin 설정 변경
UpdatePortPlugin Port Plugin 설정 변경
UpdateProcessPlugin Process Plugin 설정 변경

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

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

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

API 설명
SendData Cloud Insight로 JSON 데이터 전송
QueryData Cloud Insight에 저장된 time-series 데이터 조회
QueryDataMultiple Cloud Insight에 저장된 time-series 데이터 다중 조회
QueryWidgetDataPreview Metric을 지정하여 위젯 미리 보기 데이터 조회

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

API 설명
CreateIntegration Integration을 생성
DeleteIntegration Integration을 삭제
GetIntegration Integration을 조회
GetIntegrationList Integration 목록을 조회
UpdateIntegration Integration을 업데이트

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

API 설명
CreateMetricExport Metric Export를 생성
DeleteMetricExport Metric Export를 삭제
GetMetricExport Metric Export를 상세 내용을 조회
GetMetricExportList Metric Export를 목록을 조회
GetMetricExportFailedStatus Metric Export 실패 이력을 조회
UpdateMetricExport Metric Export를 수정

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