등록 세부정보 조회
    • PDF

    등록 세부정보 조회

    • PDF

    기사 요약

    개요

    URL 및 SCENARIO의 세부 정보를 조회합니다.

    요청 URL

    GET https://wms.apigw.fin-ntruss.com/api/v1/scenarios/{scenarioId}
    
    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시나리오 아이디모니터링 등록된 서비스마다 발급되는 아이디

    예시

    요청 예시

    GET https://wms.apigw.fin-ntruss.com/api/v1/scenarios/1
    
    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}
    

    응답 예시

    {
      "scenarioId": 1,
      "name": "네이버 클라우드",
      "monitoringType": "URL",
      "serviceType": "PC",
      "interval": 1,
      "requestTimeout": 5000,
      "runTimeout": 30000,
      "serviceYn": true,
      "methodType": "GET",
      "url": "https://www.ncloud.com",
      "lastMonitoringTime": 1620125880000,
      "successCount": 1157,
      "errorCount": 42,
      "avgLoadTime": 2389,
      "avgRunTime": 2397,
      "locations": [
        {
          "code": "KR",
          "name": "한국"
        }
      ],
      "alarms": {
        "scenarioId": 1,
        "name": "Default",
        "threshold": 3,
        "interval": 1,
        "period": 3,
        "useYn": true,
        "creator": "1",
        "templateId": 11,
        "smsEmailConfigs": [],
        "webhooks": [
          {
            "id": 1,
            "name": "webhhok",
            "url": "https://hooks.slack.com/services/....",
            "memberNo": 1,
            "createdDate": 1620125893424,
            "updatedDate": 1620125893424
          }
        ]
      }
    }
    
    항목Type설명비고
    scenarioIdInteger시나리오 아이디
    nameString서비스 이름
    monitoringTypeString모니터링 유형URL / SCENARIO
    serviceTypeString서비스 유형PC / MOBILE
    intervalInteger모니터링 주기
    requestTimeoutInteger요청 제한 시간 (millisecond)
    runTimeoutInteger실행 제한 시간 (millisecond)
    serviceYnBoolean모니터링 상태true : 시작
    false : 정지
    methodTypeString요청 유형GET / POST / DELETE / PUT
    urlStringURL
    lastMonitoringTimeLong최근 모니터링 수집 시간
    successCountInteger모니터링 결과가 정상인 횟수기준 : 00시 ~ 현재
    errorCountInteger오류가 감지된 횟수기준 : 00시 ~ 현재
    avgLoadTimeInteger페이지 평균 로드 타임
    avgRunTimeInteger시나리오 평균 실행 시간
    locations.codeString국가 코드KR : 한국
    USW : 미국(서부)
    JP : 일본
    HK : 홍콩
    SG : 싱가폴
    DE : 독일
    locations.nameString국가명
    alarms.thresholdInteger알람 임계치(건)
    alarms.periodInteger알람 임계치 측정 기간(분)
    alarms.intervalInteger알람 발송 주기(시간)
    alarms.useYnBoolean알람 사용 유무
    alarms.smsEmailConfigs.managerNameString통보 대상자 이름
    alarms.smsEmailConfigs.cellPhoneNoString통보 대상자 휴대폰
    alarms.smsEmailConfigs.emailAddressString통보 대상자 이메일
    alarms.smsEmailConfigs.informTypeString통보 방법EMAIL/ESMS/SMS/NONE
    webhooks.nameStringwebhook 이름
    webhooks.urlStringwebhook url

    오류 코드

    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.