Monitoring API 개요

네이버 클라우드 플랫폼은 NAVER의 최신 컴퓨팅 기술과 운영 노하우가 축적된 클라우드 서비스입니다.
네이버 클라우드 플랫폼에서 제공하는 여러 가지 상품군 중에 솔루션 상품을 이용할 수 있도록 제공하는 응용 프로그램 인터페이스(API)를 네이버 클라우드 플랫폼 API라고 합니다.
네이버 클라우드 API는 RESTful형태로 제공됩니다.
HTTP 방식의 GET / POST 메소드 호출을 통해서 이루어집니다.

공통설정

  • {MONITORING_API_URL}
https://ncloud.apigw.ntruss.com/monitoring/v1
  • request header
Header Description
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(millisecond)로 나타낸 것이다.
APIGW 서버와 시간차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-apigw-api-key API Gateway에서 발급받은 키
x-ncp-iam-access-key NCP에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey
x-ncp-apigw-signature-v1 위 예제의 Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명
HMAC 암호화 알고리즘은 HmacSHA256 사용

API References


Monitoring

getMetricStatistics

  • API명

    Metric별 통계 정보 조회

  • action

    getMetricStatistics

  • 설명

    네이버 클라우드 플랫폼에서는 (서버)인스턴스들의 Metric에 대한 통계 정보를 일정 주기마다 수집하고 있으며, 사용자가 이를 활용할 수 있도록 조회 API를 제공합니다.

  • 요청 파라미터

파라미터명 간략 설명 타입 제약 필수여부
instanceNoList (서버)인스턴스번호 String Min:1, Max:30 Yes
metricName 통계 항목(Metric) 이름 String Yes
startTime 조회 시작일시 Date Yes
endTime 조회 종료일시 Date Yes
period 조회주기 (초) String Yes
  1. instanceNo
    • 통계 정보를 조회할 (서버)인스턴스번호 리스트를 입력합니다.
  2. metricName

    • 통계 정보를 조회하려고 하는 항목(Metric)의 이름을 입력합니다.
    • 아래의 값들이 입력될 수 있습니다.

      CPU사용률(CPUUtilization) | 디스크의 데이터를 저장하는 용량(DiskWriteBytes) | 디스크의 데이터를 읽어들이는 용량(DiskReadBytes) | 초당 전송 비트수 - 수신(NetworkIn) | 초당 전송 비트수 - 송신 (NetworkOut)
      
  3. startTime

    • 통계 데이터의 최초 조회 시점을 입력합니다.
    • 아래와 같은 형식으로 입력해야 합니다.

      형식 : yyyy-MM-dd'T'HH:mm:ssZ
      예제 : 2013-07-25T17:50:00+0900, 2013-07-25T08:50:00Z
      
  4. endTime

    • 통계 데이터의 마지막 조회 시점을 입력합니다.
    • 아래와 같은 형식으로 입력해야 합니다.

      형식 : yyyy-MM-dd'T'HH:mm:ssZ
      예제 : 2013-07-25T17:50:00+0900, 2013-07-25T08:50:00Z
      
  5. period

    • 통계 데이터를 추출하기 위한 기초 데이터의 수집 기간을 입력합니다.
    • 아래와 같은 수집 기간을 입력할 수 있습니다.

      수집기간 데이터 보관주기
      1분 8일
      5분 40일
      30분 6개월
      2시간 2년
      1일 5년
  • Example

    • 요청

      {MONITORING_API_URL}/getMetricStatistics
      ?instanceNoList.1=68417
      &metircName=CPUUtilization
      &startTime=2014-06-10T17:50:00+0900
      &endTime=2014-06-10T18:50:00+0900
      &period=1800
      
    • 응답

      <getMetricStatisticsResponse>
      <requestId>d3ea7fbd-9bff-4ff0-a2ef-78817575943e</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <statistics>
      <statistic>
      <instanceNo>68417</instanceNo>
      <dataPoints>
      <label>CPUUtilization</label>
      <average>0.08812500000000001</average>
      <maximum>0.090833</maximum>
      <minimum>0.085417</minimum>
      <sum>0.17625000000000002</sum>
      <member>
      <timestamp>2014-06-10T09:00:00Z</timestamp>
      <average>0.090833</average>
      <unit>Percent</unit>
      </member>
      <member>
      <timestamp>2014-06-10T09:30:00Z</timestamp>
      <average>0.085417</average>
      <unit>Percent</unit>
      </member>
      </dataPoints>
      </statistic>
      </statistics>
      </getMetricStatisticsResponse>
      

getListMetrics

  • API명

    Metric 리스트 조회

  • action

    getListMetrics

  • 설명

    통계 정보를 제공 받을 수 있는 항목(Metric)이 어떤 것들이 있는지 조회할 수 있는 API를 제공합니다.

  • 요청 파라미터

    파라미터명 간략 설명 타입 제약 필수여부
    instanceNo (서버)인스턴스번호 String Yes
    metricName 통계 항목(Metric) 이름 String No
    1. instanceNo
      • 조회할 대상이 되는 (서버)인스턴스 번호를 입력합니다.
    2. metricName

      • 특정 항목(Metric)이 통계 정보로 제공 가능한지 확인할 때 입력합니다.
      • 아래의 값들이 입력될 수 있습니다.

        CPU사용률(CPUUtilization) | 디스크의 데이터를 저장하는 용량(DiskWriteBytes) | 디스크의 데이터를 읽어들이는 용량(DiskReadBytes) | 초당 전송 비트수 - 수신(NetworkIn) | 초당 전송 비트수 - 송신 (NetworkOut)
        
  • Example

    • 요청

      {MONITORING_API_URL}/getListMetric
      ?instanceNo=68417
      
    • 응답

      <getListMetricsResponse>
      <requestId>77122dd7-e61f-4f43-ba0b-f17a1b52b760</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <metrics>
      <member>
      <instanceNo>68417</instanceNo>
      <metricName>CPUUtilization</metricName>
      </member>
      <member>
      <instanceNo>68417</instanceNo>
      <metricName>DiskReadBytes</metricName>
      </member>
      <member>
      <instanceNo>68417</instanceNo>
      <metricName>DiskWriteBytes</metricName>
      </member>
      <member>
      <instanceNo>68417</instanceNo>
      <metricName>NetworkIn</metricName>
      </member>
      <member>
      <instanceNo>68417</instanceNo>
      <metricName>NetworkOut</metricName>
      </member>
      </metrics>
      </getListMetricsResponse>
      

""에 대한 건이 검색되었습니다.

    ""에 대한 검색 결과가 없습니다.

    처리중...