경보 관리 개방형 API

릴리스 버전: Yokohama

업데이트 날짜 2025년 01월 30일

읽기50분

경보 관리 개방형 API는 이벤트 [em_event] 및 경보 [em_alert] 테이블에서 데이터를 생성, 업데이트 및 검색할 수 있는 엔드포인트를 제공합니다.

Telecommunications Alarm Management Open API(sn_ind_tmf642)는 TM Forum Open API 사양의 구현입니다 ServiceNow® . 이 API는 2020년 4월 TMF642 경보 관리 API REST 사양 릴리스 20을 기반으로 합니다.

호출 사용자는 sn_ind_tmf642.alarm_mgmt_integration 엔드포인트에 액세스해야 합니다.

이 API는 sn_ind_tmf642 네임스페이스 내에서 제공됩니다.

TM Forum Open API 사양에는 수신하는 모든 인바운드 요청에 대한 동기 응답이 필요합니다. 시스템에 페이로드를 전달하기 전에 소스 운영 지원 시스템(OSS)에서 상관관계 및 중복 제거를 적용합니다.

이 API는 필수 매개변수, 요청 본문 확인, 추가 REST 작업 및 필드 매핑에 대한 사용자 지정을 수행하도록 확장할 수 있습니다. 자세한 내용은 알람 관리 개방형 API 개발자 가이드.

Alarm Management Open API는 TM Forum의 적합성 인증을 받았습니다.

TMF 적합성 로고

알람 관리 개방형 API – GET /sn_ind_tmf642/alarm_mgmt/alarm

이벤트 [em_event] 및 경보 [em_alert] 테이블에서 모든 경보 기록 목록을 검색합니다.

URL 형식

기본 URL: /api/sn_ind_tmf642/alarm_mgmt/alarm

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
없음

표 2. 쿼리 매개변수
이름	설명
알람 발생 시간	경보가 발생한 날짜입니다. 이 파라미터의 값과 일치하는 날짜가 있는 경보만 응답에 반환됩니다. 데이터 유형: 문자열
필드	응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: alarmedObject 알람 발생 시간 알람 유형 crossedThresholdInformation 외부 경보 ID ID 심각도 인식 probable원인 소스 소스 시스템 ID 상태 유형 기본값: 모든 필드 데이터 유형: 문자열
ID	경보 ID입니다. 이 파라미터의 값과 일치하는 ID가 있는 경보만 응답에 반환됩니다. 데이터 유형: 문자열 테이블: 이벤트 [em_event] 테이블의 메시지 키 필드
제한	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 사용하여 offset 기록 검색을 페이지 매김합니다. 기본값: 1000 최대: 2000 데이터 유형: 숫자
오프셋	기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 데이터 유형: 숫자 기본값: 0
probable원인	경보의 가능한 원인입니다. 이 파라미터의 값과 일치하는 가능한 원인이 있는 경보만 응답에 반환됩니다. 데이터 유형: 문자열
상태	경보 상태입니다. 이 파라미터의 값과 일치하는 상태의 경보만 응답에 반환됩니다. 데이터 유형: 문자열
소스 시스템 ID	경보의 소스 시스템 ID입니다. 이 파라미터의 값과 일치하는 소스 시스템 ID가 있는 경보만 응답에 반환됩니다. 데이터 유형: 문자열

표 3. 요청 본문 매개변수(JSON)
이름	설명
안 함

머리글

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더
헤더	설명
없음

표 5. 응답 헤더
헤더	설명
콘텐츠 범위	페이지 매김된 호출에서 반환된 콘텐츠의 범위입니다. 예를 들어, `offset=2` 및 `limit=3`인 경우 헤더의 Content-Range 값은 `항목 3-5`입니다.
콘텐츠-형식	응답 본문의 데이터 형식입니다. .만 지원합니다 application/json.
링크	쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. 첫 번째 마지막 다음 이전
X-Total-Count	페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드
상태 코드	설명
200	요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환됩니다(페이지 매김 없음).
206	응답으로 반환된 부분 자원(페이지 매김 포함).
400	잘못된 요청. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
affectedService	경보의 영향을 받는 하나 이상의 서비스 목록입니다. 데이터 유형: 객체 배열 `"affectedService":[ { "href": "String", "id": "String" }, ]`
affectedService.href	영향을 받는 서비스에 대한 상세 정보를 제공하는 URL 참조입니다. 데이터 유형: 문자열
affectedService.id	경보의 영향을 받는 서비스의 식별자입니다. 이 값은 경보의 영향을 받는 CI(구성 항목)에 매핑됩니다. 데이터 유형: 문자열
경보 상세 정보	경보에 대한 추가 세부 정보입니다. 데이터 유형: 문자열
alarmedObject	경보 객체의 상세 정보입니다. `"alarmedObject": { "href": "String", "id": "String" }` 데이터 유형: 객체
alarmedObject.id	경보 객체의 고유 식별자입니다. 이 값은 시스템의 CI에 매핑됩니다. 데이터 유형: 문자열
alarmedObject.href	경보 객체의 상세 정보를 가져오기 위한 URL 참조입니다. 데이터 유형: 문자열
alarmedObjectType	이벤트와 연결된 객체의 유형 또는 클래스입니다. 데이터 유형: 문자열
알람 발생 시간	소스에서 경보가 발생한 날짜 및 시간입니다. 데이터 유형: 문자열
알람 보고시간	OSS가 경보를 보고하는 날짜 및 시간입니다. 이 값은 값과 alarmRaisedTime 다를 수 있습니다. 예를 들어, 요소 관리 시스템(EMS)이 경보 목록을 유지하는 경우: NE alarmRaisedTime (네트워크 요소)에 의한 경보 감지 시간입니다. EMS alarmReportingTime 알람 목록에 저장된 알람 보고서 시간입니다. 데이터 유형: 문자열
알람 유형	경보 범주입니다. 데이터 유형: 문자열
crossedThresholdInformation	초과한 임계치에 대한 상세 정보입니다. 데이터 유형: 객체 `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
crossedThresholdInformation.direction	임계치 교차 방향입니다. 유효한 값은 다음과 같습니다. 솜털 위로 데이터 유형: 문자열
crossedThresholdInformation.granularity	임계치 교차에 대해 표시기가 평가되는 세분성입니다. 예: `5MINUTES.` 데이터 유형: 문자열
crossedThresholdInformation.indicatorName	경보 임계값을 초과하는 표시기의 이름입니다. 데이터 유형: 문자열
crossedThresholdInformation.indicatorUnit	교차된 임계치에 해당하는 표시기의 측정 단위입니다. 데이터 유형: 문자열
crossedThresholdInformation.observedValue	임계치를 넘는 표시기를 식별하는 번호입니다. 데이터 유형: 문자열
crossedThresholdInformation.thresholdCrossingDescription	임계치 초과 경보에 대한 자세한 임계치 세부 정보입니다. 데이터 유형: 문자열
crossedThresholdInformation.thresholdId	경보를 발생시킨 임계치의 고유 식별자입니다. 데이터 유형: 문자열
crossedThresholdInformation.thresholdRef	임계치 객체의 URL입니다. 데이터 유형: 문자열
외부 경보 ID	경보를 게시하는 소스 시스템의 경보에 대한 고유 식별자입니다. 데이터 유형: 문자열
href	자원의 URL입니다. 데이터 유형: 문자열
ID	시스템에서 경보 페이로드를 이벤트로 식별하고 처리하기 위한 고유 식별자입니다. 데이터 유형: 문자열
심각도 인식	경보 심각도입니다. 유효한 값은 다음과 같습니다. 맑다 CRITICAL 전공 사소한 경고 데이터 유형: 문자열
plannedOutageIndication	이 경보에 대한 관리 대상 객체가 계획된 중단 상태임을 나타냅니다. 예를 들어 계획된 유지보수 또는 사용 불능이 있습니다. 데이터 유형: 문자열
probable원인	경보를 트리거할 가능성이 가장 높은 상황입니다. 경보를 검증하기 위해 사용합니다 alarmType . 데이터 유형: 문자열
proposedRepairActions	시스템에서 사용 가능한 경우 경보를 트리거하는 문제를 해결하기 위한 복구 작업을 제공합니다. 데이터 유형: 문자열
serviceAffecting	경보가 서비스에 영향을 주는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 경보는 서비스 성능 또는 가용성에 영향을 줍니다. false: 알람이 서비스에 영향을 미치지 않습니다. 기본값: false 데이터 유형: 부울
소스 시스템 ID	소스 경보의 인스턴스 ID입니다. 데이터 유형: 문자열
특정 문제	경보를 트리거하는 특정 문제입니다. 알람을 검증하는 tparameter o와 probableCause 함께 사용합니다. 데이터 유형: 문자열
상태	경보 상태입니다. 유효한 값은 다음과 같습니다. 오류 무시됨 준비 처리됨 잘못된 값이 제공되면 상태가 `준비`로 설정됩니다. 상태가 `준비`이면 경보 [em_alert] 테이블에 경보가 생성되고 상태는 `처리됨`이 됩니다. 상태가 `처리됨`, `무시`됨 또는 `오류` 이면 경보가 생성되지 않습니다. 기본값: 준비 데이터 유형: 문자열

cURL 요청

이 예에서는 모든 경보를 검색합니다.

curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

응답 본문.

[
   {
      "externalAlarmId": "2212331",
      "alarmType": "QualityOfServiceAlarm23",
      "perceivedSeverity": "MAJOR",
      "probableCause": "ProbB",
      "sourceSystemId": "checkSB",
      "alarmedObject": {
         "id": "vManage_000000",
         "href": " http://api/alarmedobject/000000"
      },
      "crossedThresholdInformation": {
         "direction": "111",
         "granularity": "1234",
         "indicatorName": "sdfgds",
         "indicatorUnit": "asdfdsaf",
         "observedValue": "adsfds",
         "thresholdId": "12fasdfasdfasd",
         "thresholdCrossingDescription": "S23rtring",
         "thresholdRef": "asdfasf"
      },
      "type": "QualityOfServiceAlarm",
      "ackState": "acknowledged",
      "specificProblem": "Inbound Traffic threshold crossed",
      "alarmedObjectType": "ROUTER",
      "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
      "state": "processed",
      "alarmChangedTime": "2017-08-15T07:04:15.666Z",
      "proposedRepairActions": "Switch in standby equipment",
      "alarmReportingTime": "2017-06-15T07:04:15.666Z",
      "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
      "plannedOutageIndication": "IN_SERVICE",
      "serviceAffecting": true,
      "affectedService": [
         {
            "id": "SD WAN Enterprise Solutions",
            "href": "http://api/service/vlan_dot0_dot0"
         },
         {
            "id": "Santa Clara SD WAN Application Service",
            "href": "http://api/service/vlan_dot0_dot0"
         }
      ],
      "source": "Alarm Management Open API",
      "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
      "id": "001a0ca629078d10f87759e2f69e4c64_2212331"
   },
   {
      "externalAlarmId": "2212331",
      "alarmType": "QualityOfServiceAlarm23",
      "perceivedSeverity": "MAJOR",
      "probableCause": "ProbB",
      "sourceSystemId": "checkSB",
      "alarmedObject": {
         "id": "vManage_000000",
         "href": " http://api/alarmedobject/000000"
      },
      "crossedThresholdInformation": {
         "direction": "111",
         "granularity": "1234",
         "indicatorName": "sdfgds",
         "indicatorUnit": "asdfdsaf",
         "observedValue": "adsfds",
         "thresholdId": "12fasdfasdfasd",
         "thresholdCrossingDescription": "S23rtring",
         "thresholdRef": "asdfasf"
      },
      "type": "QualityOfServiceAlarm",
      "ackState": "acknowledged",
      "specificProblem": "Inbound Traffic threshold crossed",
      "alarmedObjectType": "ROUTER",
      "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
      "state": "processed",
      "alarmChangedTime": "2017-08-15T07:04:15.666Z",
      "proposedRepairActions": "Switch in standby equipment",
      "alarmReportingTime": "2017-06-15T07:04:15.666Z",
      "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
      "plannedOutageIndication": "IN_SERVICE",
      "serviceAffecting": true,
      "affectedService": [
         {
            "id": "SD WAN Enterprise Solutions",
            "href": "http://api/service/vlan_dot0_dot0"
         },
         {
            "id": "Santa Clara SD WAN Application Service",
            "href": "http://api/service/vlan_dot0_dot0"
         }
      ],
      "source": "Alarm Management Open API",
      "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001c84aa29078d10f87759e2f69e4cfa_2212331",
      "id": "001c84aa29078d10f87759e2f69e4cfa_2212331"
   }
]

알람 관리 개방형 API – GET /sn_ind_tmf642/alarm_mgmt/alarm/{id}

이벤트 [em_event] 또는 경보 [em_alert] 테이블에서 지정된 경보 기록을 조회합니다.