등록 세부정보 조회
- 인쇄
- PDF
등록 세부정보 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
URL 및 SCENARIO의 세부 정보를 조회합니다.
요청 URL
GET https://wms.apigw.gov-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 | 설명 | 비고 |
---|---|---|---|---|
scenarioId | Yes | Integer | 시나리오 아이디 | 모니터링 등록된 서비스마다 발급되는 아이디 |
예시
요청 예시
GET https://wms.apigw.gov-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 | 설명 | 비고 |
---|---|---|---|
scenarioId | Integer | 시나리오 아이디 | |
name | String | 서비스 이름 | |
monitoringType | String | 모니터링 유형 | URL / SCENARIO |
serviceType | String | 서비스 유형 | PC / MOBILE |
interval | Integer | 모니터링 주기 | |
requestTimeout | Integer | 요청 제한 시간 (millisecond) | |
runTimeout | Integer | 실행 제한 시간 (millisecond) | |
serviceYn | Boolean | 모니터링 상태 | true : 시작 false : 정지 |
methodType | String | 요청 유형 | GET / POST / DELETE / PUT |
url | String | URL | |
lastMonitoringTime | Long | 최근 모니터링 수집 시간 | |
successCount | Integer | 모니터링 결과가 정상인 횟수 | 기준 : 00시 ~ 현재 |
errorCount | Integer | 오류가 감지된 횟수 | 기준 : 00시 ~ 현재 |
avgLoadTime | Integer | 페이지 평균 로드 타임 | |
avgRunTime | Integer | 시나리오 평균 실행 시간 | |
locations.code | String | 국가 코드 | KR : 한국 USW : 미국(서부) JP : 일본 HK : 홍콩 SG : 싱가폴 DE : 독일 |
locations.name | String | 국가명 | |
alarms.threshold | Integer | 알람 임계치(건) | |
alarms.period | Integer | 알람 임계치 측정 기간(분) | |
alarms.interval | Integer | 알람 발송 주기(시간) | |
alarms.useYn | Boolean | 알람 사용 유무 | |
alarms.smsEmailConfigs.managerName | String | 통보 대상자 이름 | |
alarms.smsEmailConfigs.cellPhoneNo | String | 통보 대상자 휴대폰 | |
alarms.smsEmailConfigs.emailAddress | String | 통보 대상자 이메일 | |
alarms.smsEmailConfigs.informType | String | 통보 방법 | EMAIL/ESMS/SMS/NONE |
webhooks.name | String | webhook 이름 | |
webhooks.url | String | webhook url |
오류 코드
WMS API 요청 시 발생하는 공통 오류 코드입니다.
HTTP 상태 코드 | 오류 코드 | 오류 메세지 | 설명 |
---|---|---|---|
403 | E011 | Permission not found | No permissions. |
404 | E010 | Could not find the scenario. | Not Found. |
응답 예시
{
"errCode": "E010",
"errMessage": "Could not find the scenario."
}
파라미터 | 설명 |
---|---|
errCode | 오류 코드 |
errMessage | 오류 메세지 |
이 문서가 도움이 되었습니까?