모니터링 결과 조회

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

모니터링 서비스의 결과를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/scenarios/{scenarioId}/results

요청 헤더

Web service Monitoring System API에서 공통으로 사용하는 헤더에 대한 정보는 Web service Monitoring System 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`scenarioId`	Integer	Required	시나리오 아이디 모니터링 목록 조회를 통해 확인 가능

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`from`	Long	Required	조회 시작 시간 Unix Timestamp 형식
`to`	Long	Required	조회 종료 시간 Unix Timestamp 형식
`type`	String	Required	모니터링 결과 데이터 유형 `RAW` \| `MIN5` \| `MIN30` \| `MIN30` `RAW`: 전체 `MIN5`: 5분 집계 `MIN30`: 30분 집계 `HOUR2`: 2시간 집계 `DAY1`: 1일 집계
`resultStatus`	String	Optional	모니터링 결과 `SUCCESS` \| `ERROR` `SUCCESS`: 성공 `ERROR`: 실패
`locationTypeCodes`	String	Optional	모니터링 측정 Agent가 위치한 국가 `KR` \| `USW` \| `JP` \| `SG` \| `DE` `KR`: 한국 `USW`: 미국(서부) `JP`: 일본 `SG`: 싱가포르 `DE`: 독일 2개 이상 선택 시 쉼표(,)로 구분

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://wms.apigw.gov-ntruss.com/api/v1/scenarios/{scenarioId}/results?from=1696790400&to=1697404800&type=MIN5' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`avgLoadTime`	Integer	-	페이지 평균 로드 시간 (밀리초)
`avgRunTime`	Integer	-	시나리오 평균 실행 시간 (밀리초)
`successCount`	Integer	-	모니터링 결과 정상 건수 기준: 조회 기간
`errorCount`	Integer	-	모니터링 결과 오류 건수 기준:조회 기간
`totalCount`	Integer	-	모니터링 결과 전체 건수 기준: 조회 기간
`availability`	Integer	-	서비스 가용성 기준: 조회 기간
`results`	Array	-	모니터링 결과

`results`

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

필드	타입	필수 여부	설명
`_id`	String	-	모니터링 결과 아이디 모니터링 상세 결과 조회 시 `resultId`로 사용
`scenarioId`	Integer	-	시나리오 아이디
`locationTypeCodes`	String	Optional	모니터링 측정 Agent가 위치한 국가 `KR` \| `USW` \| `JP` \| `SG` \| `DE` `KR`: 한국 `USW`: 미국(서부) `JP`: 일본 `SG`: 싱가포르 `DE`: 독일 2개 이상 선택 시 쉼표(,)로 구분
`resultStatus`	String	Optional	모니터링 결과 `SUCCESS` \| `ERROR` `SUCCESS`: 성공 `ERROR`: 실패
`avgLoadTime`	Integer	-	페이지 평균 로드 시간 (밀리초)
`avgRunTime`	Integer	-	시나리오 평균 실행 시간 (밀리초)
`collectTime`	Long	-	시나리오 집계 기준 시간 Unix Timestamp 형식
`stime1d`	Long	-	시나리오 집계 기준 일 Unix Timestamp 형식
`successCount`	Integer	-	모니터링 결과 정상 건수 기준: 조회 기간
`errorCount`	Integer	-	모니터링 결과 오류 건수 기준:조회 기간
`totalCount`	Integer	-	모니터링 결과 전체 건수 기준: 조회 기간

응답 상태 코드

Web service Monitoring System API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Web service Monitoring System 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "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
    },
    
    ...
    
  ]
}