모니터링 조회

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

모니터링 서비스의 상세 정보를 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://wms.apigw.gov-ntruss.com/api/v1/scenarios/{scenarioId}' \
--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' \

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`scenarioId`	Integer	-	시나리오 아이디
`name`	String	-	모니터링 서비스 이름
`monitoringType`	String	-	모니터링 유형 `URL` \| `SCENARIO` `URL`: 모니터링 시나리오 스텝에 URL 접속 스텝만 추가된 경우 `SCENARIO`: 모니터링 시나리오 스텝에 URL 접속 포함 2개 이상의 스텝이 추가된 경우
`serviceType`	String	-	모니터링 서비스 유형 `PC` \| `MOBILE` `PC` `MOBILE`
`interval`	Integer	-	모니터링 실행 주기 (분) `1` \| `5` \| `10`
`requestTimeout`	Integer	-	모니터링 요청 대기 시간 (밀리초) `5000` \| `10000` \| `30000`
`runTimeout`	Integer	-	모니터링 시나리오 실행 대기 시간 (밀리초) `30000` \| `40000` \| `50000` \| `60000`
`serviceYn`	Boolean	-	모니터링 상태 `true` \| `false` `true`: 시작 `false`: 일시 정지
`methodType`	String	-	모니터링 요청 유형 `GET` \| `POST` \| `DELETE` \| `PUT`
`url`	String	-	웹 서비스 URL 주소 모니터링 대상
`lastMonitoringTime`	Long	-	최근 모니터링 수집 시간 Unix Timestamp 형식
`successCount`	Integer	-	모니터링 결과 정상 건수 기준: 00시~현재
`errorCount`	Integer	-	모니터링 결과 오류 건수 기준: 00시~현재
`avgLoadTime`	Integer	-	페이지 평균 로드 시간 (밀리초)
`avgRunTime`	Integer	-	시나리오 평균 실행 시간 (밀리초)
`locations`	Array	-	모니터링 측정 Agent가 위치한 국가
`alarms`	Object	-	알람 설정 정보
`alarms.scenarioId`	Integer	-	알람 시나리오 아이디
`alarms.name`	String	-	알람 이름
`alarms.threshold`	Integer	-	알람 임계치 (건)
`alarms.interval`	Integer	-	알람 발송 주기 (시간)
`alarms.period`	Integer	-	알람 임계치 측정 시간 (분)
`alarms.useYn`	Boolean	-	알람 사용 유무 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`alarms.creator`	Integer	-	알람 생성자 네이버 클라우드 플랫폼 회원 번호 표시
`alarms.templateId`	Integer	-	알람 템플릿 아이디
`alarms.smsEmailConfigs`	Array	-	SMS/EMAIL 설정 정보
`alarms.webhooks`	Array	-	Webhook 설정 정보

`locations`

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

필드	타입	필수 여부	설명
`code`	String	-	국가 코드 `KR` \| `USW` \| `JP` \| `SG` \| `DE`
`name`	String	-	국가 이름 `한국` \| `미국(서부)` \| `일본` \| `싱가포르` \| `독일`

`smsEmailConfigs`

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

필드	타입	필수 여부	설명
`managerName`	String	-	통보 대상 관리자 이름
`managerNo`	Integer	-	통보 대상 관리자 번호
`cellPhoneNo`	Integer	-	통보 대상 전화번호
`memberNo`	Integer	-	통보 대상 번호
`emailAddress`	String	-	통보 대상 메일 주소
`informType`	String	-	통보 방법 `EMAIL` \| `SMS` \| `ESMS` `EMAIL`: 이메일로 통보 `SMS`: 문자로 통보 `ESMS`: 이메일과 문자로 통보

`webhooks`

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

필드	타입	필수 여부	설명
`id`	Integer	-	Webhook 아이디
`name`	String	-	Webhook 이름
`url`	String	-	Webhook URL
`memberNo`	Integer	-	Webhook 대상자 네이버 클라우드 플랫폼 회원 번호 표시
`createdDate`	Integer	-	Webhook 생성 날짜 Unix Timestamp 형식
`updatedDate`	Integer	-	Webhook 수정 날짜 Unix Timestamp 형식

응답 상태 코드

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

응답 예시

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

{
    "scenarioId": 7488,
    "name": "test_ncloud",
    "monitoringType": "SCENARIO",
    "serviceType": "PC",
    "interval": 1,
    "requestTimeout": 5000,
    "runTimeout": 30000,
    "serviceYn": true,
    "methodType": "GET",
    "url": "https://www.ncloud.com",
    "lastMonitoringTime": 1728579720000,
    "successCount": 38,
    "errorCount": 0,
    "avgLoadTime": 2961,
    "avgRunTime": 4070,
    "locations": [
        {
            "code": "KR",
            "name": "한국"
        }
    ],
    "alarms": {
        "scenarioId": 7488,
        "name": "Default",
        "threshold": 3,
        "interval": 1,
        "period": 3,
        "useYn": true,
        "creator": "*******",
        "templateId": 14355,
        "smsEmailConfigs": [
            {
                "managerName": "홍길동",
                "managerNo": 88139,
                "cellPhoneNo": "010********",
                "memberNo": 88139,
                "emailAddress": "gildong.hong@*****.com",
                "informType": "EMAIL"
            }
        ],
        "webhooks": [
            {
                "id": 113,
                "name": "wh_ncloud",
                "url": "https://www.ncloud.com",
                "memberNo": *******,
                "createdDate": 1728579753484,
                "updatedDate": 1728579753484
            }
        ]
    }
}