--- sourceDocument: 호주 API 참조 sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/api-reference Release : - australia ft:locale : - ko-KR ft:publication_title : - 호주 API 참조 ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # 경보 관리 개방형 API # 경보 관리 개방형 API {#ariaid-title1} * 릴리스 버전: Australia * * 업데이트 날짜 2026년 03월 12일 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 소요 시간: 50분 경보 관리 개방형 API는 이벤트 \[em_event\] 및 경보 \[em_alert\] 테이블에서 데이터를 생성, 업데이트 및 검색할 수 있는 엔드포인트를 제공합니다. 통신 경보 관리 Open API(sn_ind_tmf642)는 ServiceNow® TM Forum Open API 사양의 구현입니다. 이 API는 [TMF642 경보 관리 API 사용자 가이드 v5.0.0](https://www.tmforum.org/resources/specifications/tmf642-alarm-management-api-user-guide-v5-0-0/), 2023년 9월을 기반으로 합니다. 호출 사용자는 `sn_ind_tmf642.alarm_mgmt_integration` 엔드포인트에 액세스해야 합니다. 이 API는 `sn_ind_tmf642` 네임스페이스 내에서 제공됩니다. TM Forum Open API 사양은 수신하는 모든 인바운드 요청에 대해 동기 응답을 요구합니다. 페이로드를 시스템에 전달하기 전에 소스 OSS(운영 지원 시스템)에서 상관 관계 및 중복 제거를 적용합니다. 이 API는 필수 매개변수, 요청 본문 확인, 추가 REST 작업 및 필드 매핑을 사용자 지정하도록 확장할 수 있습니다. 자세한 내용은 다음을 참조하십시오.[경보 관리 개방형 API 개발자 가이드](https://servicenow-prod.fluidtopics.net/46yCPkIHAGH0K2kx5L7P3Q#alarm-mgmt_dev-guide "경보 관리 개방형 API를 사용하여 이벤트 [em_event] 테이블에 데이터를 생성하고 업데이트합니다."). Alarm Management Open API는 TM Forum의 적합성 인증을 받았습니다. ## 경보 관리 개방형 API -- GET /sn_ind_tmf642/alarm_mgmt/alarm {#ariaid-title2} 이벤트 \[em_event\] 및 경보 \[em_alert\] 테이블에서 모든 경보 기록의 목록을 조회합니다. ### URL 형식 기본 URL: /api/sn_ind_tmf642/alarm_mgmt/alarm ### 지원되는 요청 매개변수 {#alarm-GET-alarm__entry__2} | 이름 | 설명 | |-|-| | 없음 | | [표 1. 경로 매개변수] {#alarm-GET-alarm__table_qcn_fkm_qtb__entry__2} | 이름 | 설명 | |-|-| | alarmRaisedTime | 경보가 발생한 날짜입니다. 이 매개변수의 값과 일치하는 날짜가 있는 경보만 응답에 반환됩니다. 데이터 유형: 문자열 | | 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: * alarmedObject * alarmRaisedTime * 경보 유형 * crossedThresholdInformation * externalAlarmId * ID * 인식된 심각도 * probableCause * 소스 * 소스 시스템Id * 상태 * 유형 {#alarm-GET-alarm__ul_n1h_htz_54b} 기본값: 모든 필드 데이터 유형: 문자열 | | ID | 경보 ID입니다. 이 매개변수의 값과 일치하는 ID가 있는 경보만 응답에 반환됩니다. 데이터 유형: 문자열 테이블: 이벤트 \[em_event\] 테이블의 메시지 키 필드에 있습니다. | | 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 1000 최대: 2000 데이터 유형: 숫자 | | 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 데이터 유형: 숫자 기본값: 0 | | probableCause | 경보의 가능한 원인입니다. 이 매개변수의 값과 일치하는 상당한 원인이 있는 경보만 응답에 반환됩니다. 데이터 유형: 문자열 | | 상태 | 경보 상태입니다. 이 매개변수의 값과 일치하는 상태의 경보만 응답에 반환됩니다. 데이터 유형: 문자열 | | 소스 시스템Id | 경보의 소스 시스템 ID입니다. 소스 시스템 ID가 이 매개변수의 값과 일치하는 경보만 응답에 반환됩니다. 데이터 유형: 문자열 | [표 2. 쿼리 매개변수] {#alarm-GET-alarm__table_qcn_fkm_qtb} {#alarm-GET-alarm__entry__24} | 이름 | 설명 | |-|-| | 안 함 | | [표 3. 요청 본문 매개변수(JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-GET-alarm__table_rgh_drm_qtb__entry__2} | 머리글 | 설명 | |-|-| | 안 함 | | [표 4. 요청 헤더] {#alarm-GET-alarm__table_rgh_drm_qtb} {#alarm-GET-alarm__table_c2r_4gm_lsb__entry__2}{#alarm-GET-alarm__content-range-row}{#alarm-GET-alarm__content-type-row}{#alarm-GET-alarm__links-pagination-row}{#alarm-GET-alarm__x-total-count-descr} | 머리글 | 설명 | |-|-| | 컨텐츠-범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위입니다. 예를 들어, `offset=2` 및 `limit=3`인 경우 헤더의 Content-Range 값은 `항목 3-5`입니다. | | 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. | | 링크 | 쿼리 결과를 탐색하는 다음 링크가 포함되어 있습니다. * 첫 번째 * 마지막 * 다음 * 이전 {#alarm-GET-alarm__ul_zzk_sdm_lsb} | | X-합계-카운트 | 페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 기록 수를 지정합니다. | [표 5. 응답 헤더] {#alarm-GET-alarm__table_c2r_4gm_lsb} ### 상태 코드 이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 [REST API HTTP 응답 코드를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-GET-alarm__table_qbg_4cm_lsb__entry__2}{#alarm-GET-alarm__tmf-get-status-200-p}{#alarm-GET-alarm__tmf-get-status-206-entry}{#alarm-GET-alarm__tmf-get-status-400-entry}{#alarm-GET-alarm__tmf-get-status-404-entry} | 상태 코드 | 설명 | |-|-| | 200 | 요청이 성공적으로 처리되었습니다. 응답에서 전체 자원이 반환되었습니다(페이지 매김 없음). | | 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). | | 400 | 잘못된 요청. 가능한 이유: * 잘못된 경로 매개변수 * 잘못된 URI {#alarm-GET-alarm__ul_rys_1gy_fsb} | | 404 | 기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다. | [표 6. 상태 코드] {#alarm-GET-alarm__table_qbg_4cm_lsb} ### 응답 본문 매개변수(JSON) {#alarm-GET-alarm__table_zjc_fbg_qtb__entry__2}{#alarm-GET-alarm__alm-mgmt-affectedService-entry}{#alarm-GET-alarm__alm-mgmt-affectedServiceHREF-entry}{#alarm-GET-alarm__alm-mgmt-create-alarmobj-href-entry}{#alarm-GET-alarm__alm-mgmt-specificProb-ph} | 이름 | 설명 | |-|-| | 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 | 이벤트와 연결된 객체의 유형 또는 클래스입니다. 데이터 유형: 문자열 | | alarmRaisedTime | 소스에서 경보가 발생한 날짜 및 시간입니다. 데이터 유형: 문자열 | | alarmReportingTime | OSS에서 경보를 보고하는 날짜 및 시간입니다. 이 값은 값과 다를 수 있습니다.alarmRaisedTime 예를 들어, 요소 관리 시스템(EMS)이 경보 목록을 유지 관리하는 경우: * alarmRaisedTime 네트워크 요소(NE)에 의한 경보 탐지 시간입니다. * alarmReportingTime EMS 알람 목록에 저장되어 있는 알람 보고서 시간입니다. {#alarm-GET-alarm__ul_mbt_1rf_ynb} 데이터 유형: 문자열 | | 경보 유형 | 경보 범주입니다. 데이터 유형: 문자열 | | crossedThresholdInformation | 초과된 임계치에 대한 상세 정보입니다. 데이터 유형: 객체 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } | | 교차한 임계치정보.방향 | 임계치 교차 방향입니다. 유효한 값은 다음과 같습니다. * 아래로 * 위로 {#alarm-GET-alarm__ul_fsb_jlg_ynb} 데이터 유형: 문자열 | | crossedThresholdInformation.granularity | 표시기의 임계치 교차를 평가하는 세분성입니다. 예: `5MINUTES.` 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorName | 경보 임계치를 초과하는 표시기의 이름입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorUnit | 교차된 임계치에 해당하는 표시기의 측정 단위입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.observedValue | 임계치를 넘는 표시기를 식별하는 번호입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdCrossingDescription | 임계치 초과 경보에 대한 자세한 임계치 상세 정보입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdId | 경보를 발생시킨 임계치의 고유 식별자입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdRef | 임계치 객체의 URL입니다. 데이터 유형: 문자열 | | externalAlarmId | 경보를 게시하는 소스 시스템에서 경보에 대한 고유 식별자입니다. 데이터 유형: 문자열 | | href | 자원의 URL입니다. 데이터 유형: 문자열 | | ID | 시스템에서 경보 페이로드를 식별하고 이벤트로 처리하기 위한 고유 식별자입니다. 데이터 유형: 문자열 | | 인식된 심각도 | 경보 심각도입니다. 유효한 값은 다음과 같습니다. * 투명 * 중요 * 주요 * 경미함 * 경고 {#alarm-GET-alarm__ul_vcp_c4f_ynb} 데이터 유형: 문자열 | | plannedOutageIndication | 이 경보에 대해 관리되는 객체가 계획된 중단 상태임을 나타냅니다. 예를 들어 계획된 유지보수 또는 서비스 중단이 있습니다. 데이터 유형: 문자열 | | probableCause | 경보를 트리거할 가능성이 가장 높은 상황입니다. 함께 alarmType 사용하여 경보를 검증합니다. 데이터 유형: 문자열 | | 제안된 복구 작업 | 시스템에서 사용 가능한 경우 경보를 트리거하는 문제를 해결하기 위한 복구 작업을 제공합니다. 데이터 유형: 문자열 | | serviceAffecting | 경보가 서비스에 영향을 미치는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 경보는 서비스 성능 또는 가용성에 영향을 줍니다. * false: 경보는 서비스에 영향을 주지 않습니다. {#alarm-GET-alarm__ul_omz_dnf_ynb} 기본값: false 데이터 유형: 부울 | | 소스 시스템Id | 소스 경보의 인스턴스 ID입니다. 데이터 유형: 문자열 | | 특정 문제 | 경보를 트리거하는 특정 문제입니다. tparameter와 함께 probableCause 사용하면 알람을 검증할 수 있습니다. 데이터 유형: 문자열 | | 상태 | 경보 상태입니다. 유효한 값은 다음과 같습니다. * 오류 * 무시됨 * 준비 * 처리됨 {#alarm-GET-alarm__ul_ilh_3jt_xnb}잘못된 값이 제공되면 상태가 `준비로` 설정됩니다. 상태가 `준비이`면 경보 \[em_alert\] 테이블에 경보가 생성되고 상태는 `처리됨이 됩니다.` 상태가 `처리됨`, `무시됨` 또는 `오류` 이면 경보가 생성되지 않습니다. 기본값: 준비 데이터 유형: 문자열 | [ ] {#alarm-GET-alarm__table_zjc_fbg_qtb} ### 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} {#ariaid-title3} 이벤트 \[em_event\] 또는 경보 \[em_alert\] 테이블에서 지정된 경보 기록을 조회합니다. ### URL 형식 기본 URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id} ### 지원되는 요청 매개변수 {#alarm-GET-alarm-id__entry__2} | 이름 | 설명 | |-|-| | ID | 검색할 기록의 고유 식별자입니다. 데이터 유형: 문자열 테이블: 이벤트 \[em_event\] 테이블의 메시지 키 필드에 있습니다. | [표 7. 경로 매개변수] {#alarm-GET-alarm-id__entry__6} | 이름 | 설명 | |-|-| | 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: * alarmedObject * alarmRaisedTime * 경보 유형 * crossedThresholdInformation * externalAlarmId * ID * 인식된 심각도 * probableCause * 소스 * 소스 시스템Id * 상태 * 유형 {#alarm-GET-alarm-id__ul_n1h_htz_54b} 기본값: 모든 필드 데이터 유형: 문자열 | [표 8. 쿼리 매개변수] {#alarm-GET-alarm-id__entry__10} | 이름 | 설명 | |-|-| | 안 함 | | [표 9. 요청 본문 매개변수(JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-GET-alarm-id__entry__14}{#alarm-GET-alarm-id__accept-JSON-only-entry-RESTAPI} | 머리글 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. | [표 10. 요청 헤더] {#alarm-GET-alarm-id__entry__18} | 머리글 | 설명 | |-|-| | 안 함 | | [표 11. 응답 헤더] ### 상태 코드 이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 [REST API HTTP 응답 코드를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-GET-alarm-id__entry__22}{#alarm-GET-alarm-id__entry-200-status-code} | 상태 코드 | 설명 | |-|-| | 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청입니다. 다음 이유 중 하나 이상으로 인해 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. * 잘못된 경로 매개변수입니다. * 잘못된 URI입니다. {#alarm-GET-alarm-id__ul_rjf_fqw_rpb} | | 404 | 기록 없음 지정된 ID와 관련된 기록을 이벤트 \[em_event\] 또는 경보 \[em_alert\] 테이블에서 찾을 수 없습니다. | [표 12. 상태 코드] ### 응답 본문 매개변수(JSON) {#alarm-GET-alarm-id__table_gtd_dbg_qtb__entry__2}{#alarm-GET-alarm-id__alm-mgmt-affectedService-entry}{#alarm-GET-alarm-id__alm-mgmt-affectedServiceHREF-entry}{#alarm-GET-alarm-id__alm-mgmt-create-alarmobj-href-entry}{#alarm-GET-alarm-id__alm-mgmt-specificProb-ph} | 이름 | 설명 | |-|-| | 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 | 이벤트와 연결된 객체의 유형 또는 클래스입니다. 데이터 유형: 문자열 | | alarmRaisedTime | 소스에서 경보가 발생한 날짜 및 시간입니다. 데이터 유형: 문자열 | | alarmReportingTime | OSS에서 경보를 보고하는 날짜 및 시간입니다. 이 값은 값과 다를 수 있습니다.alarmRaisedTime 예를 들어, 요소 관리 시스템(EMS)이 경보 목록을 유지 관리하는 경우: * alarmRaisedTime 네트워크 요소(NE)에 의한 경보 탐지 시간입니다. * alarmReportingTime EMS 알람 목록에 저장되어 있는 알람 보고서 시간입니다. {#alarm-GET-alarm-id__ul_mbt_1rf_ynb} 데이터 유형: 문자열 | | 경보 유형 | 경보 범주입니다. 데이터 유형: 문자열 | | crossedThresholdInformation | 초과된 임계치에 대한 상세 정보입니다. 데이터 유형: 객체 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } | | 교차한 임계치정보.방향 | 임계치 교차 방향입니다. 유효한 값은 다음과 같습니다. * 아래로 * 위로 {#alarm-GET-alarm-id__ul_fsb_jlg_ynb} 데이터 유형: 문자열 | | crossedThresholdInformation.granularity | 표시기의 임계치 교차를 평가하는 세분성입니다. 예: `5MINUTES.` 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorName | 경보 임계치를 초과하는 표시기의 이름입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorUnit | 교차된 임계치에 해당하는 표시기의 측정 단위입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.observedValue | 임계치를 넘는 표시기를 식별하는 번호입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdCrossingDescription | 임계치 초과 경보에 대한 자세한 임계치 상세 정보입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdId | 경보를 발생시킨 임계치의 고유 식별자입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdRef | 임계치 객체의 URL입니다. 데이터 유형: 문자열 | | externalAlarmId | 경보를 게시하는 소스 시스템에서 경보에 대한 고유 식별자입니다. 데이터 유형: 문자열 | | href | 자원의 URL입니다. 데이터 유형: 문자열 | | ID | 시스템에서 경보 페이로드를 식별하고 이벤트로 처리하기 위한 고유 식별자입니다. 데이터 유형: 문자열 | | 인식된 심각도 | 경보 심각도입니다. 유효한 값은 다음과 같습니다. * 투명 * 중요 * 주요 * 경미함 * 경고 {#alarm-GET-alarm-id__ul_vcp_c4f_ynb} 데이터 유형: 문자열 | | plannedOutageIndication | 이 경보에 대해 관리되는 객체가 계획된 중단 상태임을 나타냅니다. 예를 들어 계획된 유지보수 또는 서비스 중단이 있습니다. 데이터 유형: 문자열 | | probableCause | 경보를 트리거할 가능성이 가장 높은 상황입니다. 함께 alarmType 사용하여 경보를 검증합니다. 데이터 유형: 문자열 | | 제안된 복구 작업 | 시스템에서 사용 가능한 경우 경보를 트리거하는 문제를 해결하기 위한 복구 작업을 제공합니다. 데이터 유형: 문자열 | | serviceAffecting | 경보가 서비스에 영향을 미치는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 경보는 서비스 성능 또는 가용성에 영향을 줍니다. * false: 경보는 서비스에 영향을 주지 않습니다. {#alarm-GET-alarm-id__ul_omz_dnf_ynb} 기본값: false 데이터 유형: 부울 | | 소스 시스템Id | 소스 경보의 인스턴스 ID입니다. 데이터 유형: 문자열 | | 특정 문제 | 경보를 트리거하는 특정 문제입니다. tparameter와 함께 probableCause 사용하면 알람을 검증할 수 있습니다. 데이터 유형: 문자열 | | 상태 | 경보 상태입니다. 유효한 값은 다음과 같습니다. * 오류 * 무시됨 * 준비 * 처리됨 {#alarm-GET-alarm-id__ul_ilh_3jt_xnb}잘못된 값이 제공되면 상태가 `준비로` 설정됩니다. 상태가 `준비이`면 경보 \[em_alert\] 테이블에 경보가 생성되고 상태는 `처리됨이 됩니다.` 상태가 `처리됨`, `무시됨` 또는 `오류` 이면 경보가 생성되지 않습니다. 기본값: 준비 데이터 유형: 문자열 | [ ] {#alarm-GET-alarm-id__table_gtd_dbg_qtb} ### cURL 요청 이 예에서는 경보를 검색합니다. curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331" \ --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": "ind_name", "indicatorUnit": "ind_unit", "observedValue": "232", "thresholdId": "200", "thresholdCrossingDescription": "sample_description", "thresholdRef": "sample_ref" }, "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" } ## 경보 관리 개방형 API -- PATCH /sn_ind_tmf642/alarm_mgmt/alarm/{id} {#ariaid-title4} 지정된 경보 및 관련된 경보를 업데이트합니다. 이 엔드포인트는 이벤트 \[em_event\] 테이블에 있는 이벤트 기록의 추가 정보 필드에 응답 본문을 씁니다. ### URL 형식 기본 URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id} ### 지원되는 요청 매개변수 {#alarm-PATCH__entry__2} | 이름 | 설명 | |-|-| | ID | 업데이트할 기록의 고유 식별자입니다. 데이터 유형: 문자열 테이블: 이벤트 \[em_event\] 테이블의 메시지 키 필드에 있습니다. | [표 13. 경로 매개변수] {#alarm-PATCH__entry__6} | 이름 | 설명 | |-|-| | 없음 | | [표 14. 쿼리 매개변수] {#alarm-PATCH__table_kmr_mjs_xnb__entry__2}{#alarm-PATCH__alm-mgmt-affectedService-entry}{#alarm-PATCH__alm-mgmt-affectedServiceHREF-entry}{#alarm-PATCH__alm-mgmt-perceivedSeverity-desc}{#alarm-PATCH__alm-mgmt-specificProb-ph} | 이름 | 설명 | |-|-| | affectedService | 경보의 영향을 받는 하나 이상의 서비스 목록입니다. 데이터 유형: 객체 배열 "affectedService":[ { "href": "String", "id": "String" }, ] | | affectedService.href | 영향을 받는 서비스에 대한 상세 정보를 제공하는 URL 참조입니다. 데이터 유형: 문자열 | | affectedService.id | 필수 경보의 영향을 받는 서비스의 식별자입니다. 이 값은 경보의 영향을 받는 CI(구성 항목)에 매핑됩니다. 데이터 유형: 문자열 | | alarmChangedTime | 경보 소유 시스템에서 경보가 변경된 마지막 날짜 및 시간을 나타냅니다. 경보를 변경하면 경보가 발생한 자원에서 제공되거나 클라이언트의 변경에 의해 트리거되는지 여부에 관계없이 이 값이 업데이트됩니다. 데이터 유형: 문자열 | | 경보 세부 정보 | 경보에 대한 추가 상세 정보입니다. 데이터 유형: 문자열 | | 경보에스컬레이션 | 경보 심각도의 에스컬레이션을 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 경보 심각도가 에스컬레이션되고 있습니다. * false: 경보 심각도가 같거나 낮습니다. {#alarm-PATCH__ul_kkj_4jh_ynb} 기본값: false 데이터 유형: 부울 | | crossedThresholdInformation | 초과된 임계치에 대한 상세 정보입니다. 데이터 유형: 객체 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } | | 교차한 임계치정보.방향 | 임계치 교차 방향입니다. 유효한 값은 다음과 같습니다. * 아래로 * 위로 {#alarm-PATCH__ul_fsb_jlg_ynb} 데이터 유형: 문자열 | | crossedThresholdInformation.granularity | 표시기의 임계치 교차를 평가하는 세분성입니다. 예: `5MINUTES.` 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorName | 경보 임계치를 초과하는 표시기의 이름입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorUnit | 교차된 임계치에 해당하는 표시기의 측정 단위입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.observedValue | 임계치를 넘는 표시기를 식별하는 번호입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdCrossingDescription | 임계치 초과 경보에 대한 자세한 임계치 상세 정보입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdId | 필수 경보를 발생시킨 임계치의 고유 식별자입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdRef | 임계치 객체의 URL입니다. 데이터 유형: 문자열 | | href | 경보에 대한 URL 참조입니다. 데이터 유형: 문자열 | | 인식된 심각도 | 필수 경보 심각도입니다. 유효한 값은 다음과 같습니다. * 투명 * 중요 * 주요 * 경미함 * 경고 {#alarm-PATCH__ul_vcp_c4f_ynb} 데이터 유형: 문자열 | | plannedOutageIndication | 이 경보에 대해 관리되는 객체가 계획된 중단 상태임을 나타냅니다. 예를 들어 계획된 유지보수 또는 서비스 중단이 있습니다. 데이터 유형: 문자열 | | probableCause | 필수 경보를 트리거할 가능성이 가장 높은 상황입니다. 함께 alarmType 사용하여 경보를 검증합니다. 데이터 유형: 문자열 | | 제안된 복구 작업 | 시스템에서 사용 가능한 경우 경보를 트리거하는 문제를 해결하기 위한 복구 작업을 제공합니다. 데이터 유형: 문자열 | | serviceAffecting | 경보가 서비스에 영향을 미치는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 경보는 서비스 성능 또는 가용성에 영향을 줍니다. * false: 경보는 서비스에 영향을 주지 않습니다. {#alarm-PATCH__ul_omz_dnf_ynb} 기본값: false 데이터 유형: 부울 | | 특정 문제 | 경보를 트리거하는 특정 문제입니다. tparameter와 함께 probableCause 사용하면 알람을 검증할 수 있습니다. 데이터 유형: 문자열 | [표 15. 요청 본문 매개변수(JSON)] {#alarm-PATCH__table_kmr_mjs_xnb} ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-PATCH__entry__56}{#alarm-PATCH__accept-JSON-only-entry-RESTAPI}{#alarm-PATCH__content_type-JSON-only-entry-RESTAPI} | 머리글 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. | | 콘텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. | [표 16. 요청 헤더] {#alarm-PATCH__table_jwc_bxs_xnb__entry__2} | 머리글 | 설명 | |-|-| | 안 함 | | [표 17. 응답 헤더] {#alarm-PATCH__table_jwc_bxs_xnb} ### 상태 코드 이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 [REST API HTTP 응답 코드를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-PATCH__table_ifj_lyb_ynb__entry__2} | 상태 코드 | 설명 | |-|-| | 201 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청. 가능한 이유: * 잘못된 페이로드입니다. 필요한 경보 ID가 누락되었습니다. * 잘못된 페이로드입니다. 필수 필드 누락:\<필드 이름\>. * 잘못된 페이로드입니다. 필수 객체가 누락되었습니다. * 이벤트가 생성되지 않았습니다. 실패했습니다. * 이벤트를 지울 수 없습니다. * 이벤트를 업데이트할 수 없습니다. * 이벤트가 존재하지 않습니다. {#alarm-PATCH__ul_f4x_sdb_ynb} | [표 18. 상태 코드] {#alarm-PATCH__table_ifj_lyb_ynb} ### 응답 본문 매개변수(JSON) {#alarm-PATCH__entry__72} | 이름 | 설명 | |-|-| | alarmChangedTime | 알람 소유 시스템에서 알람이 변경된 날짜 및 시간(GMT)입니다. 이 값은 경보가 발생한 자원에서 경보가 변경되거나 클라이언트 업데이트의 변경으로 경보가 트리거될 때 업데이트됩니다. 이 값은 응답에 필요합니다. 데이터 유형: 문자열 | | href | 경보에 대한 URL 참조입니다. 데이터 유형: 문자열 | | ID | 경보의 고유 식별자입니다. 경보를 소유한 시스템에서 결정하는 값입니다. 데이터 유형: 문자열 | [ ] ### cURL 요청 이 예에서는 심각도가 경미로 격하되었습니다. curl "https://.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_" \ --request PATCH \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"href\":\"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00\", \"externalAlarmId\":\"\", \"alarmType\":\"QualityOfServiceAlarm\", \"type\":\"QualityOfServiceAlarm\", \"ackState\":\"acknowledged\", \"perceivedSeverity\":\"MINOR\", \"probableCause\":\"Threshold crossed\", \"specificProblem\":\"Inbound Traffic threshold crossed\", \"alarmedObjectType\":\"ROUTER\", \"alarmedObject\":{ \"id\":\"vManage_000000\", \"href\":\" http://api/alarmedobject/000000\" }, \"sourceSystemId\":\"SOURCE_SYSTEM_vManage_00000_000_00\", \"alarmDetails\":\"Software Failure on SD-WAN Controller vManage_000000\", \"alarmEscalation\": false, \"state\":\"RAISED\", \"alarmChangedTime\":\"2017-08-15T07:04:15.666Z\", \"proposedRepairActions\":\"Switch in standby equipment\", \"alarmReportingTime\":\"2017-06-15T07:04:15.666Z\", \"alarmRaisedTime\":\"2020-09-15T07:04:15.666Z\", \"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\" } ] }" \ --user 'user:'password' 응답 본문. { "result": { "alarmChangedTime": "2017-08-15T07:04:15.666Z", "id": "6e116bb8db09201087b9a8394b961950_" } } ## 경보 관리 개방형 API -- POST /sn_ind_tmf642/alarm_mgmt/alarm {#ariaid-title5} 이벤트 \[em_event\] 테이블에 경보 기록을 생성합니다. 경보 기록이 생성되면 경보의 ID가 필드에 Message key 추가됩니다. [경보 관리 규칙](https://www.servicenow.com/docs/access?context=alert-management-rule&version=australia&pubname=australia-it-operations-management&ft:locale=en-US)에 따라 경보 기록을 만들 수도 있습니다. 이 엔드포인트는 이벤트 \[em_event\] 테이블에 있는 이벤트 기록의 추가 정보 필드에 응답 본문을 씁니다. ### URL 형식 기본 URL: /api/sn_ind_tmf642/alarm_mgmt/alarm ### 지원되는 요청 매개변수 {#alarm-POST-create__entry__2} | 이름 | 설명 | |-|-| | 없음 | | [표 19. 경로 매개변수] {#alarm-POST-create__entry__6} | 이름 | 설명 | |-|-| | 없음 | | [표 20. 쿼리 매개변수] {#alarm-POST-create__entry__10}{#alarm-POST-create__alm-mgmt-affectedService-entry}{#alarm-POST-create__alm-mgmt-affectedServiceHREF-entry}{#alarm-POST-create__alm-mgmt-create-alarmobj-href-entry}{#alarm-POST-create__alm-mgmt-create-alarmtype}{#alarm-POST-create__alm-mgmt-perceivedSeverity-desc}{#alarm-POST-create__alm-mgmt-specificProb-ph} | 이름 | 설명 | |-|-| | 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 | 이벤트와 연결된 객체의 유형 또는 클래스입니다. 데이터 유형: 문자열 | | alarmRaisedTime | 소스에서 경보가 발생한 날짜 및 시간입니다. 데이터 유형: 문자열 | | alarmReportingTime | OSS에서 경보를 보고하는 날짜 및 시간입니다. 이 값은 값과 다를 수 있습니다.alarmRaisedTime 예를 들어, 요소 관리 시스템(EMS)이 경보 목록을 유지 관리하는 경우: * alarmRaisedTime 네트워크 요소(NE)에 의한 경보 탐지 시간입니다. * alarmReportingTime EMS 알람 목록에 저장되어 있는 알람 보고서 시간입니다. {#alarm-POST-create__ul_mbt_1rf_ynb} 데이터 유형: 문자열 | | 경보 유형 | 필수 경보 범주입니다. 데이터 유형: 문자열 | | crossedThresholdInformation | 초과된 임계치에 대한 상세 정보입니다. 데이터 유형: 객체 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } | | 교차한 임계치정보.방향 | 임계치 교차 방향입니다. 유효한 값은 다음과 같습니다. * 아래로 * 위로 {#alarm-POST-create__ul_fsb_jlg_ynb} 데이터 유형: 문자열 | | crossedThresholdInformation.granularity | 표시기의 임계치 교차를 평가하는 세분성입니다. 예: `5MINUTES.` 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorName | 경보 임계치를 초과하는 표시기의 이름입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorUnit | 교차된 임계치에 해당하는 표시기의 측정 단위입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.observedValue | 임계치를 넘는 표시기를 식별하는 번호입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdCrossingDescription | 임계치 초과 경보에 대한 자세한 임계치 상세 정보입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdId | 필수 경보를 발생시킨 임계치의 고유 식별자입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdRef | 임계치 객체의 URL입니다. 데이터 유형: 문자열 | | externalAlarmId | 필수 경보를 게시하는 소스 시스템에서 경보에 대한 고유 식별자입니다. 데이터 유형: 문자열 | | ID | 시스템에서 경보 페이로드를 식별하고 이벤트로 처리하기 위한 고유 식별자입니다. 페이로드에 사용되는 경우 이 값은 비어 있어야 합니다. 시스템은 이벤트에 대해 이 고유 ID를 생성하고 응답 페이로드의 일부로 보냅니다. 데이터 유형: 문자열 | | 인식된 심각도 | 필수 경보 심각도입니다. 유효한 값은 다음과 같습니다. * 투명 * 중요 * 주요 * 경미함 * 경고 {#alarm-POST-create__ul_vcp_c4f_ynb} 데이터 유형: 문자열 | | plannedOutageIndication | 이 경보에 대해 관리되는 객체가 계획된 중단 상태임을 나타냅니다. 예를 들어 계획된 유지보수 또는 서비스 중단이 있습니다. 데이터 유형: 문자열 | | probableCause | 필수 경보를 트리거할 가능성이 가장 높은 상황입니다. 함께 alarmType 사용하여 경보를 검증합니다. 데이터 유형: 문자열 | | 제안된 복구 작업 | 시스템에서 사용 가능한 경우 경보를 트리거하는 문제를 해결하기 위한 복구 작업을 제공합니다. 데이터 유형: 문자열 | | serviceAffecting | 경보가 서비스에 영향을 미치는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 경보는 서비스 성능 또는 가용성에 영향을 줍니다. * false: 경보는 서비스에 영향을 주지 않습니다. {#alarm-POST-create__ul_omz_dnf_ynb} 기본값: false 데이터 유형: 부울 | | 소스 시스템Id | 필수 소스 경보의 인스턴스 ID입니다. 데이터 유형: 문자열 | | 특정 문제 | 경보를 트리거하는 특정 문제입니다. tparameter와 함께 probableCause 사용하면 알람을 검증할 수 있습니다. 데이터 유형: 문자열 | | 상태 | 경보 상태입니다. 유효한 값은 다음과 같습니다. * 오류 * 무시됨 * 준비 * 처리됨 {#alarm-POST-create__ul_ilh_3jt_xnb}잘못된 값이 제공되면 상태가 `준비로` 설정됩니다. 상태가 `준비이`면 경보 \[em_alert\] 테이블에 경보가 생성되고 상태는 `처리됨이 됩니다.` 상태가 `처리됨`, `무시됨` 또는 `오류` 이면 경보가 생성되지 않습니다. 기본값: 준비 데이터 유형: 문자열 | [표 21. 요청 본문 매개변수(JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-POST-create__entry__72}{#alarm-POST-create__accept-JSON-only-entry-RESTAPI}{#alarm-POST-create__content_type-JSON-only-entry-RESTAPI} | 머리글 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. | | 콘텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. | [표 22. 요청 헤더] {#alarm-POST-create__table_vrm_1xs_xnb__entry__2} | 머리글 | 설명 | |-|-| | 안 함 | | [표 23. 응답 헤더] {#alarm-POST-create__table_vrm_1xs_xnb} ### 상태 코드 이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 [REST API HTTP 응답 코드를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-POST-create__table_bly_lyb_ynb__entry__2} | 상태 코드 | 설명 | |-|-| | 201 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청. 가능한 이유: * 잘못된 페이로드입니다. 필요한 경보 ID가 누락되었습니다. * 잘못된 페이로드입니다. 필수 필드 누락:\<필드 이름\>. * 잘못된 페이로드입니다. 필수 객체가 누락되었습니다. * 이벤트가 생성되지 않았습니다. 실패했습니다. * 이벤트를 지울 수 없습니다. * 이벤트를 업데이트할 수 없습니다. * 이벤트가 존재하지 않습니다. {#alarm-POST-create__ul_f4x_sdb_ynb} | [표 24. 상태 코드] {#alarm-POST-create__table_bly_lyb_ynb} ### 응답 본문 매개변수(JSON) {#alarm-POST-create__entry__88}{#alarm-POST-create__d3882e76}{#alarm-POST-create__d3882e89}{#alarm-POST-create__d3882e403}{#alarm-POST-create__d3882e342} | 이름 | 설명 | |-|-| | 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 | 이벤트와 연결된 객체의 유형 또는 클래스입니다. 데이터 유형: 문자열 | | alarmRaisedTime | 소스에서 경보가 발생한 날짜 및 시간입니다. 데이터 유형: 문자열 | | alarmReportingTime | OSS에서 경보를 보고하는 날짜 및 시간입니다. 이 값은 값과 다를 수 있습니다.alarmRaisedTime 예를 들어, 요소 관리 시스템(EMS)이 경보 목록을 유지 관리하는 경우: * alarmRaisedTime 네트워크 요소(NE)에 의한 경보 탐지 시간입니다. * alarmReportingTime EMS 알람 목록에 저장되어 있는 알람 보고서 시간입니다. {#alarm-POST-create__d3882e459} 데이터 유형: 문자열 | | 경보 유형 | 경보 범주입니다. 데이터 유형: 문자열 | | crossedThresholdInformation | 초과된 임계치에 대한 상세 정보입니다. 데이터 유형: 객체 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } | | 교차한 임계치정보.방향 | 임계치 교차 방향입니다. 유효한 값은 다음과 같습니다. * 아래로 * 위로 {#alarm-POST-create__d3882e144} 데이터 유형: 문자열 | | crossedThresholdInformation.granularity | 표시기의 임계치 교차를 평가하는 세분성입니다. 예: `5MINUTES.` 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorName | 경보 임계치를 초과하는 표시기의 이름입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.indicatorUnit | 교차된 임계치에 해당하는 표시기의 측정 단위입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.observedValue | 임계치를 넘는 표시기를 식별하는 번호입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdCrossingDescription | 임계치 초과 경보에 대한 자세한 임계치 상세 정보입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdId | 경보를 발생시킨 임계치의 고유 식별자입니다. 데이터 유형: 문자열 | | crossedThresholdInformation.thresholdRef | 임계치 객체의 URL입니다. 데이터 유형: 문자열 | | externalAlarmId | 경보를 게시하는 소스 시스템에서 경보에 대한 고유 식별자입니다. 데이터 유형: 문자열 | | href | 자원의 URL입니다. 데이터 유형: 문자열 | | ID | 시스템에서 경보 페이로드를 식별하고 이벤트로 처리하기 위한 고유 식별자입니다. 데이터 유형: 문자열 | | 인식된 심각도 | 경보 심각도입니다. 유효한 값은 다음과 같습니다. * 투명 * 중요 * 주요 * 경미함 * 경고 {#alarm-POST-create__d3882e252} 데이터 유형: 문자열 | | plannedOutageIndication | 이 경보에 대해 관리되는 객체가 계획된 중단 상태임을 나타냅니다. 예를 들어 계획된 유지보수 또는 서비스 중단이 있습니다. 데이터 유형: 문자열 | | probableCause | 경보를 트리거할 가능성이 가장 높은 상황입니다. 함께 alarmType 사용하여 경보를 검증합니다. 데이터 유형: 문자열 | | 제안된 복구 작업 | 시스템에서 사용 가능한 경우 경보를 트리거하는 문제를 해결하기 위한 복구 작업을 제공합니다. 데이터 유형: 문자열 | | serviceAffecting | 경보가 서비스에 영향을 미치는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 경보는 서비스 성능 또는 가용성에 영향을 줍니다. * false: 경보는 서비스에 영향을 주지 않습니다. {#alarm-POST-create__d3882e322} 기본값: false 데이터 유형: 부울 | | 소스 시스템Id | 소스 경보의 인스턴스 ID입니다. 데이터 유형: 문자열 | | 특정 문제 | 경보를 트리거하는 특정 문제입니다. tparameter와 함께 probableCause 사용하면 알람을 검증할 수 있습니다. 데이터 유형: 문자열 | | 상태 | 경보 상태입니다. 유효한 값은 다음과 같습니다. * 오류 * 무시됨 * 준비 * 처리됨 {#alarm-POST-create__d3882e538}잘못된 값이 제공되면 상태가 `준비로` 설정됩니다. 상태가 `준비이`면 경보 \[em_alert\] 테이블에 경보가 생성되고 상태는 `처리됨이 됩니다.` 상태가 `처리됨`, `무시됨` 또는 `오류` 이면 경보가 생성되지 않습니다. 기본값: 준비 데이터 유형: 문자열 | [ ] ### cURL 요청 이 예에서는 경보를 만듭니다. curl "https://.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ "href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00", "externalAlarmId":"", "alarmType":"QualityOfServiceAlarm", "type":"QualityOfServiceAlarm", "ackState":"acknowledged", "perceivedSeverity":"CRITICAL", "probableCause":"Threshold crossed", "specificProblem":"Inbound Traffic threshold crossed", "alarmedObjectType":"ROUTER", "alarmedObject":{ "id":"vManage_000000", "href":" http://api/alarmedobject/000000" }, "sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00", "alarmDetails":"Software Failure on SD-WAN Controller vManage_000000", "state":"RAISED", "alarmChangedTime":"2017-08-15T07:04:15.666Z", "proposedRepairActions":"Switch in standby equipment", "alarmReportingTime":"2017-06-15T07:04:15.666Z", "alarmRaisedTime":"2020-09-15T07:04:15.666Z", "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" } ] }" \ --user 'user':'password' 응답 본문. { "href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00", "externalAlarmId":"", "alarmType":"QualityOfServiceAlarm", "type":"QualityOfServiceAlarm", "ackState":"acknowledged", "perceivedSeverity":"CRITICAL", "probableCause":"Threshold crossed", "specificProblem":"Inbound Traffic threshold crossed", "alarmedObjectType":"ROUTER", "alarmedObject":{ "id":"vManage_000000", "href":" http://api/alarmedobject/000000" }, "sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00", "alarmDetails":"Software Failure on SD-WAN Controller vManage_000000", "state":"RAISED", "alarmChangedTime":"2017-08-15T07:04:15.666Z", "proposedRepairActions":"Switch in standby equipment", "alarmReportingTime":"2017-06-15T07:04:15.666Z", "alarmRaisedTime":"2020-09-15T07:04:15.666Z", "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" } ] } ## 경보 관리 개방형 API -- POST /sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear {#ariaid-title6} 지정된 경보를 지우고 관련된 경보를 닫습니다. ### URL 형식 기본 URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear ### 지원되는 요청 매개변수 {#alarm-POST-clear__entry__2} | 이름 | 설명 | |-|-| | ID | 지울 경보의 고유 식별자입니다. 데이터 유형: 문자열 테이블: 이벤트 \[em_events\] 테이블의 메시지 키 필드에 있습니다. | [표 25. 경로 매개변수] {#alarm-POST-clear__entry__6} | 이름 | 설명 | |-|-| | 없음 | | [표 26. 쿼리 매개변수] {#alarm-POST-clear__entry__10} | 이름 | 설명 | |-|-| | 경보 클리어드 시간 | 소스에서 경보가 삭제되는 날짜 및 시간입니다. 데이터 유형: 문자열 테이블: 이벤트 \[em_events\] 테이블의 이벤트 시간 필드에 있습니다. | | clearSystemId | 필수 운영이 호출된 alarmCleared 인스턴스의 이름입니다. 데이터 유형: 문자열 | | clearUserId | 필수 작업을 호출한 사용자의 고유 ID입니다.alarmCleared 데이터 유형: 문자열 | [표 27. 요청 본문 매개변수(JSON)] ### 헤더 다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-POST-clear__entry__18}{#alarm-POST-clear__accept-JSON-only-entry-RESTAPI}{#alarm-POST-clear__content_type-JSON-only-entry-RESTAPI} | 머리글 | 설명 | |-|-| | 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. | | 콘텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. | [표 28. 요청 헤더] {#alarm-POST-clear__entry__24} | 이름 | 설명 | |-|-| | 안 함 | | [표 29. 응답 헤더] ### 상태 코드 이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 [REST API HTTP 응답 코드를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.") {#alarm-POST-clear__entry__28} | 상태 코드 | 설명 | |-|-| | 201 | 성공입니다. 요청이 성공적으로 처리되었습니다. | | 400 | 잘못된 요청. 가능한 이유: * 잘못된 페이로드입니다. 필요한 경보 ID가 누락되었습니다. * 잘못된 페이로드입니다. 필수 필드 누락:\<필드 이름\>. * 잘못된 페이로드입니다. 필수 객체가 누락되었습니다. * 이벤트가 생성되지 않았습니다. 실패했습니다. * 이벤트를 지울 수 없습니다. * 이벤트를 업데이트할 수 없습니다. * 이벤트가 존재하지 않습니다. {#alarm-POST-clear__ul_f4x_sdb_ynb} | [표 30. 상태 코드] ### 응답 본문 매개변수(JSON) {#alarm-POST-clear__entry__34} | 이름 | 설명 | |-|-| | 경보 클리어드 시간 | 소스에서 경보가 삭제되는 날짜 및 시간입니다. 데이터 유형: 문자열 테이블: 이벤트 \[em_events\] 테이블의 이벤트 시간 필드에 있습니다. | | clearSystemId | 운영이 호출된 alarmCleared 인스턴스의 이름입니다. 데이터 유형: 문자열 | | clearUserId | 작업을 호출한 사용자의 고유 ID입니다.alarmCleared 데이터 유형: 문자열 | | href | 경보의 URL입니다. 데이터 유형: 문자열 | | ID | 고유 ID입니다. 데이터 유형: 문자열 테이블: 이벤트 \[em_events\] 테이블에 있는 기록의 메시지 키 필드에 있습니다. | [ ] ### cURL 요청 이 예에서는 경보를 지웁니다. curl "https://.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_/clear" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"alarmClearedTime\": \"2017-08-15 06:04:15\", \"clearSystemId\": \"\", \"clearUserId\": \"SOURCE_SYSTEM_vManage_00000_000_00\" }" \ --user 'user':'password' 응답 본문. { "result": { "alarmClearedTime": "2017-08-15 06:04:15", "clearSystemId": "", "clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00", "id": "6e116bb8db09201087b9a8394b961950_" } }