모니터링 결과 조회
    • PDF

    모니터링 결과 조회

    • PDF

    Article Summary

    개요

    URL 및 SCENARIO의 모니터링 결과를 조회 합니다.

    요청 URL

    GET https://wms.apigw.ntruss.com/api/v1/scenarios/{scenarioId}/results
    
    x-ncp-apigw-timestamp: {Timestamp}
    x-ncp-iam-access-key: {Sub Account Access Key}
    x-ncp-apigw-signature-v2: {API Gateway Signature}
    

    Path Variables

    항목필수 여부Type설명비고
    scenarioIdYesInteger시나리오 아이디모니터링 등록된 서비스 마다 발급되는 아이디

    Parameters

    항목필수 여부Type설명비고
    fromYesLong조회 시작 시간
    toYesLong조회 끝 시간
    typeYesString결과 데이터 유형RAW
    MIN5 - (5분 집계)
    MIN30 - (30분 집계)
    HOUR2 - (2시간 집계)
    DAY1 - (1일 집계)
    resultStatusNoString모니터링 결과 유형SUCCESS / ERROR
    locationTypeCodesNoString모니터링 지역 코드KR - (한국)
    SG - (싱가포르)
    JP - (일본)
    USW - (미국 서부)
    DE - (독일)
    HK - (홍콩)

    여러 지역은 콤마(,)로 구분하여 요청
    ex) KR,USW

    예시

    요청 예시

    GET https://wms.apigw.ntruss.com/api/v1/scenarios/1/results?from=1620205200000&to=1620216000000&type=MIN5
    
    Content-Type: application/json; charset=utf-8
    x-ncp-apigw-timestamp: {Timestamp}
    x-ncp-iam-access-key: {Access Key}
    x-ncp-apigw-signature-v2: {API Gateway Signature}
    

    응답 예시

    {
      "avgLoadTime": 1408,
      "avgRunTime": 3526,
      "successCount": 720,
      "errorCount": 0,
      "totalCount": 720,
      "availability": 100,
      "results": [
        {
          "_id": "609287d081869e5f2eedeb8a",
          "scenarioId": 1,
          "locationTypeCode": "KR",
          "resultStatus": "SUCCESS",
          "avgLoadTime": 1472,
          "avgRunTime": 3587,
          "collectTime": 1620215700000,
          "stime1d": 1620140400000,
          "successCount": 5,
          "errorCount": 0,
          "totalCount": 5
        },
        {
          "_id": "609287d081869e5f2eedeb8b",
          "scenarioId": 1,
          "locationTypeCode": "JP",
          "resultStatus": "SUCCESS",
          "avgLoadTime": 1383,
          "avgRunTime": 3496,
          "collectTime": 1620215700000,
          "stime1d": 1620140400000,
          "successCount": 5,
          "errorCount": 0,
          "totalCount": 5
        },
        
        ...
        
      ]
    } 
    
    항목Type설명비고
    avgLoadTimeInteger조회한 기간의 페이지 평균 로드 타임
    avgRunTimeInteger조회한 기간의 시나리오 평균 실행 시간
    successCountInteger조회한 기간의 모니터링 결과가 정상인 횟수
    errorCountInteger조회한 기간의 오류가 감지된 횟수
    totalCountInteger조회한 기간의 수집된 모니터링 전체 횟수
    availabilityInteger조회한 기간의 서비스 가용성
    results._idString모니터링 결과 아이디resultId
    results.scenarioIdInteger시나리오 아이디
    results.locationTypeCodesString모니터링 지역 코드
    results.resultStatusString모니터링 수행 결과
    results.avgLoadTimeInteger페이지 평균 로드 타임
    results.avgRunTimeInteger시나리오 평균 실행 시간
    results.collectTimeLong시나리오 집계 기준 시간
    results.stime1dLong시나리오 집계 기준 일
    results.successCountInteger모니터링 결과가 정상인 횟수
    results.errorCountInteger오류가 감지된 횟수
    results.totalCountInteger수집된 모니터링 전체 횟수

    오류 코드

    WMS API 요청시 발생하는 공통 에러코드입니다.

    HTTP 상태 코드오류 코드오류 메세지설명
    403E011Permission not foundNo permissions.
    404E010Could not find the scenario.Not Found.

    응답 예시

    {
      "errCode": "E010",
      "errMessage": "Could not find the scenario."
    }
    
    파라미터설명
    errCode오류 코드
    errMessage오류 메세지

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

    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.