アラーム管理オープン API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：55分

アラーム管理オープン API は、イベント [em_event] テーブルとアラート [em_alert] テーブルからデータを作成、更新、および取得するためのエンドポイントを提供します。

Telecommunications Alarm Management Open API (sn_ind_tmf642) は、TM Forum Open API 仕様の ServiceNow® 実装です。この API は、 TMF642 Alarm Management API ユーザーガイド v5.0.0 (2023 年 9 月) に基づいています。

呼び出し元ユーザーは sn_ind_tmf642.alarm_mgmt_integration エンドポイントにアクセスする必要があります。

この API は、 sn_ind_tmf642 名前空間内で提供されます。

TM Forum Open API 仕様では、受信するすべての受信要求に対して同期応答が必要です。ペイロードをシステムに転送する前に、ソース運用サポートシステム (OSS) で相関と重複排除を適用します。

この API を拡張して、必須パラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングをカスタマイズできます。詳細については、「アラーム管理オープン API 開発者ガイド。

アラーム管理オープン API は、TM フォーラムによって適合性認定を受けています。

TMF 準拠ロゴ

アラーム管理オープン API – GET /sn_ind_tmf642/alarm_mgmt/alarm

イベント [em_event] テーブルとアラート [em_alert] テーブルからすべてのアラームレコードのリストを取得します。

URL 形式

デフォルト URL: /api/sn_ind_tmf642/alarm_mgmt/alarm

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
なし

表 : 2. クエリパラメーター
名前	説明
alarmRaisedTime	アラームが発生した日付。このパラメーターの値と一致する日付のアラームのみが応答に返されます。データタイプ：文字列
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド： alarmedObject alarmRaisedTime アラームタイプ crossedThresholdInformation 外部アラーム ID ID 知覚された重大度 probableCause ソースソースシステム ID 状況 type デフォルト:すべてのフィールドデータタイプ：文字列
ID	アラーム ID。このパラメーターの値と一致する ID を持つアラームのみが応答に返されます。データタイプ：文字列テーブル:イベント [em_event] テーブルの [メッセージキー] フィールド内。
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。デフォルト：1000 最大:2000 データタイプ：数値
オフセット	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。データタイプ：数値デフォルト：0
probableCause	アラームの考えられる原因。考えられる原因がこのパラメーターの値と一致するアラームのみが応答に返されます。データタイプ：文字列
状況	アラームステータス。このパラメーターの値と一致するステータスのアラームのみが応答に返されます。データタイプ：文字列
ソースシステム ID	アラームのソースシステム ID。このパラメーターの値と一致するソースシステム ID を持つアラームのみが応答に返されます。データタイプ：文字列

表 : 3. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
なし

表 : 5. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
「リンク」	クエリ結果間を移動するための次のリンクが含まれています。第 1 最終次へ前へ
X-合計-数	ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。
206	応答で返された部分的なリソース (ページネーションあり)。
400	要求が正しくありません。考えられる理由: 無効なパスパラメーター無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)


名前	説明
affectedService	アラームの影響を受ける 1 つ以上のサービスのリスト。データタイプ：オブジェクトのアレイ `"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アラームリストに保存されているアラームレポート時間です。データタイプ：文字列
アラームタイプ	アラームカテゴリ。データタイプ：文字列
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	resource の URL。データタイプ：文字列
ID	アラームペイロードをイベントとして識別して処理するためのシステムの一意の識別子。データタイプ:文字列
知覚された重大度	アラーム重大度。有効な値： CLEAR CRITICAL メジャーマイナー WARNING データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが予定されている機能停止ステータスであることを示します。たとえば、計画済みメンテナンスやサービス停止などです。データタイプ：文字列
probableCause	アラームをトリガーする可能性が高い状況。アラームを認定するために alarmType とともに使用します。データタイプ：文字列
proposedRepairAction	システムで利用可能な場合、アラームをトリガーする問題を解決するための修復アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響するかどうかを示すフラグ。有効な値： true:アラームはサービスのパフォーマンスまたは可用性に影響を与えます。 false:アラームはサービスに影響を与えません。デフォルト値：false データタイプ：ブーリアン
ソースシステム ID	ソースアラームのインスタンス ID。データタイプ：文字列
特定の問題	アラームをトリガーする特定の問題。アラームを認定するには、 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] テーブルから取得します。

URL 形式

デフォルト URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
ID	取得するレコードの一意の識別子。データタイプ：文字列テーブル:イベント [em_event] テーブルの [メッセージキー] フィールド内。

表 : 8. クエリパラメーター
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド： alarmedObject alarmRaisedTime アラームタイプ crossedThresholdInformation 外部アラーム ID ID 知覚された重大度 probableCause ソースソースシステム ID 状況 type デフォルト値:すべてのフィールドデータタイプ：文字列

表 : 9. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。次の 1 つ以上の理由で、不正な要求タイプまたは誤った形式の要求が検出されました。パスパラメーターが無効です。無効な URI。
404	レコードが見つかりません。指定された ID に関連付けられたレコードがイベント [em_event] テーブルまたはアラート [em_alert] テーブルに見つかりません。

応答本文のパラメーター (JSON)


名前	説明
affectedService	アラームの影響を受ける 1 つ以上のサービスのリスト。データタイプ：オブジェクトのアレイ `"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アラームリストに保存されているアラームレポート時間です。データタイプ：文字列
アラームタイプ	アラームカテゴリ。データタイプ：文字列
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	アラームペイロードをイベントとして識別して処理するためのシステムの一意の識別子。データタイプ：文字列
知覚された重大度	アラーム重大度。有効な値： CLEAR CRITICAL メジャーマイナー WARNING データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが予定されている機能停止ステータスであることを示します。たとえば、計画済みメンテナンスやサービス停止などです。データタイプ：文字列
probableCause	アラームをトリガーする可能性が高い状況。アラームを認定するために alarmType とともに使用します。データタイプ：文字列
proposedRepairAction	システムで利用可能な場合、アラームをトリガーする問題を解決するための修復アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響するかどうかを示すフラグ。有効な値： true:アラームはサービスのパフォーマンスまたは可用性に影響を与えます。 false:アラームはサービスに影響を与えません。デフォルト値：false データタイプ：ブーリアン
ソースシステム ID	ソースアラームのインスタンス ID。データタイプ：文字列
特定の問題	アラームをトリガーする特定の問題。アラームを認定するには、 probableCause パラメーターとともに使用します。データタイプ：文字列
状況	アラームステータス。有効な値：エラー無視準備完了処理日時無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。ステータスが `[準備完了`] の場合、アラート [em_alert] テーブルにアラートが作成され、ステータスが `[処理済み]` になります。ステータスが `[処理済み]`、[ `無視]`、または [ `エラー` ] の場合、アラートは作成されません。デフォルト値:準備完了データタイプ：文字列

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}

指定されたアラームと関連するアラートを更新します。

このエンドポイントは、応答本文をイベント [em_event] テーブルのイベントレコードの [追加情報 ] フィールドに書き込みます。

URL 形式

デフォルト URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}

サポートされている要求パラメーター

表 : 13. パスパラメーター
名前	説明
ID	更新するレコードの一意の識別子。データタイプ：文字列テーブル:イベント [em_event] テーブルの [メッセージキー] フィールド内。

表 : 14. クエリパラメーター
名前	説明
なし

表 : 15. 要求本文パラメーター (JSON)
名前	説明
affectedService	アラームの影響を受ける 1 つ以上のサービスのリスト。データタイプ：オブジェクトのアレイ `"affectedService":[ { "href": "String", "id": "String" }, ]`
affectedService.href	影響を受けるサービスの詳細を提供する URL 参照。データタイプ：文字列
affectedService.id	必須です。アラームの影響を受けるサービスの識別子。この値は、影響を受けるアラートの構成アイテム (CI) にマップされます。データタイプ：文字列
アラーム変更時間	アラーム所有システムでアラームが最後に変更された日時を示します。アラームを変更すると、アラーム対象のリソースからの値か、クライアントからの変更によってトリガーされるかにかかわらず、この値が更新されます。データタイプ：文字列
アラームの詳細	アラームに関するその他の詳細。データタイプ：文字列
アラームエスカレーション	アラーム重大度のエスカレーションを示すフラグ。有効な値： true:アラーム重大度がエスカレーションされています。 false:アラーム重大度は同等かそれ以下です。デフォルト値：false データタイプ：ブーリアン
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。データタイプ：文字列
href	アラームへの URL 参照。データタイプ：文字列
知覚された重大度	必須です。アラーム重大度。有効な値： CLEAR CRITICAL メジャーマイナー WARNING データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが予定されている機能停止ステータスであることを示します。たとえば、計画済みメンテナンスやサービス停止などです。データタイプ：文字列
probableCause	必須です。アラームをトリガーする可能性が高い状況。アラームを認定するために alarmType とともに使用します。データタイプ：文字列
proposedRepairAction	システムで利用可能な場合、アラームをトリガーする問題を解決するための修復アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響するかどうかを示すフラグ。有効な値： true:アラームはサービスのパフォーマンスまたは可用性に影響を与えます。 false:アラームはサービスに影響を与えません。デフォルト値：false データタイプ：ブーリアン
特定の問題	アラームをトリガーする特定の問題。アラームを認定するには、 probableCause パラメーターとともに使用します。データタイプ：文字列

ヘッダー

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。考えられる理由: 無効なペイロードです。必要なアラーム ID がありません。無効なペイロードです。必須フィールドがありません:<field name>。無効なペイロードです。必要なオブジェクトがありません。イベントが作成されていないか、失敗しました。イベントをクリアできません。イベントを更新できません。イベントが存在しません。

応答本文のパラメーター (JSON)


名前	説明
アラーム変更時間	アラーム所有システムでアラームが変更された日時 (GMT)。この値は、アラーム対象のリソースからアラームが変更されたとき、またはクライアントの更新からの変更によってアラームがトリガーされたときに更新されます。この値は応答で必須です。データタイプ：文字列
href	アラームへの URL 参照。データタイプ：文字列
ID	アラームの一意の識別子。アラームを所有するシステムによって決定される値。データタイプ：文字列

cURL 要求

この例では、重大度は [マイナー] に軽減されています。

curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>" \
--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\":\"<external-alarm-id>\",
     \"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_<external-alarm-id>"
  }
}

アラーム管理オープンAPI – POST /sn_ind_tmf642/alarm_mgmt/アラーム

イベント [em_event] テーブルにアラームレコードを作成します。

アラームレコードが作成されると、アラームの ID が [ Message key ] フィールドに追加されます。

アラート管理ルールに基づいてアラートレコードを作成することもできます。

このエンドポイントは、応答本文をイベント [em_event] テーブルのイベントレコードの [追加情報 ] フィールドに書き込みます。

URL 形式

デフォルト URL: /api/sn_ind_tmf642/alarm_mgmt/alarm

サポートされている要求パラメーター

表 : 19. パスパラメーター
名前	説明
なし

表 : 20. クエリパラメーター
名前	説明
なし

表 : 21. 要求本文パラメーター (JSON)
名前	説明
affectedService	アラームの影響を受ける 1 つ以上のサービスのリスト。データタイプ：オブジェクトのアレイ `"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アラームリストに保存されているアラームレポート時間です。データタイプ：文字列
アラームタイプ	必須です。アラームカテゴリ。データタイプ：文字列
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	必須です。アラームを投稿するソースシステムからのアラームの一意の識別子。データタイプ：文字列
ID	アラームペイロードをイベントとして識別して処理するためのシステムの一意の識別子。ペイロードで使用する場合は、この値を空にする必要があります。このイベントの一意の ID が生成され、応答ペイロードの一部として送信されます。データタイプ：文字列
知覚された重大度	必須です。アラーム重大度。有効な値： CLEAR CRITICAL メジャーマイナー WARNING データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが予定されている機能停止ステータスであることを示します。たとえば、計画済みメンテナンスやサービス停止などです。データタイプ：文字列
probableCause	必須です。アラームをトリガーする可能性が高い状況。アラームを認定するために alarmType とともに使用します。データタイプ：文字列
proposedRepairAction	システムで利用可能な場合、アラームをトリガーする問題を解決するための修復アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響するかどうかを示すフラグ。有効な値： true:アラームはサービスのパフォーマンスまたは可用性に影響を与えます。 false:アラームはサービスに影響を与えません。デフォルト値：false データタイプ：ブーリアン
ソースシステム ID	必須です。ソースアラームのインスタンス ID。データタイプ：文字列
特定の問題	アラームをトリガーする特定の問題。アラームを認定するには、 probableCause パラメーターとともに使用します。データタイプ：文字列
状況	アラームステータス。有効な値：エラー無視準備完了処理日時無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。ステータスが `[準備完了`] の場合、アラート [em_alert] テーブルにアラートが作成され、ステータスが `[処理済み]` になります。ステータスが `[処理済み]`、[ `無視]`、または [ `エラー` ] の場合、アラートは作成されません。デフォルト値:準備完了データタイプ：文字列

ヘッダー

表 : 22. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 23. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 24. ステータスコード
ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。考えられる理由: 無効なペイロードです。必要なアラーム ID がありません。無効なペイロードです。必須フィールドがありません:<field name>。無効なペイロードです。必要なオブジェクトがありません。イベントが作成されていないか、失敗しました。イベントをクリアできません。イベントを更新できません。イベントが存在しません。

応答本文のパラメーター (JSON)


名前	説明
affectedService	アラームの影響を受ける 1 つ以上のサービスのリスト。データタイプ：オブジェクトのアレイ `"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アラームリストに保存されているアラームレポート時間です。データタイプ：文字列
アラームタイプ	アラームカテゴリ。データタイプ：文字列
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	アラームペイロードをイベントとして識別して処理するためのシステムの一意の識別子。データタイプ：文字列
知覚された重大度	アラーム重大度。有効な値： CLEAR CRITICAL メジャーマイナー WARNING データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが予定されている機能停止ステータスであることを示します。たとえば、計画済みメンテナンスやサービス停止などです。データタイプ：文字列
probableCause	アラームをトリガーする可能性が高い状況。アラームを認定するために alarmType とともに使用します。データタイプ：文字列
proposedRepairAction	システムで利用可能な場合、アラームをトリガーする問題を解決するための修復アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響するかどうかを示すフラグ。有効な値： true:アラームはサービスのパフォーマンスまたは可用性に影響を与えます。 false:アラームはサービスに影響を与えません。デフォルト値：false データタイプ：ブーリアン
ソースシステム ID	ソースアラームのインスタンス ID。データタイプ：文字列
特定の問題	アラームをトリガーする特定の問題。アラームを認定するには、 probableCause パラメーターとともに使用します。データタイプ：文字列
状況	アラームステータス。有効な値：エラー無視準備完了処理日時無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。ステータスが `[準備完了`] の場合、アラート [em_alert] テーブルにアラートが作成され、ステータスが `[処理済み]` になります。ステータスが `[処理済み]`、[ `無視]`、または [ `エラー` ] の場合、アラートは作成されません。デフォルト値:準備完了データタイプ：文字列

cURL 要求

この例では、アラームを作成します。

curl "https://<instance>.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":"<external-alarm-id>",
     "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":"<external-alarm-id>",
     "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

指定されたアラームをクリアし、関連するアラートをすべてクローズします。

URL 形式

デフォルト URL: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear

サポートされている要求パラメーター

表 : 25. パスパラメーター
名前	説明
ID	クリアするアラームの一意の識別子。データタイプ：文字列テーブル:イベント [em_events] テーブルの [メッセージキー] フィールド内。

表 : 26. クエリパラメーター
名前	説明
なし

表 : 27. 要求本文パラメーター (JSON)
名前	説明
アラームクリア時間	ソースでアラームがクリアされた日時。データタイプ：文字列テーブル:イベント [em_events] テーブルの [イベントの時刻] フィールド内。
clearSystemId	必須です。 alarmCleared操作が呼び出されたインスタンスの名前。データタイプ：文字列
clearUserId	必須です。 alarmCleared操作を呼び出したユーザーの一意の ID。データタイプ：文字列

ヘッダー

表 : 28. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 29. 応答ヘッダー
名前	説明
なし

ステータスコード

表 : 30. ステータスコード
ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。考えられる理由: 無効なペイロードです。必要なアラーム ID がありません。無効なペイロードです。必須フィールドがありません:<field name>。無効なペイロードです。必要なオブジェクトがありません。イベントが作成されていないか、失敗しました。イベントをクリアできません。イベントを更新できません。イベントが存在しません。

応答本文のパラメーター (JSON)


名前	説明
アラームクリア時間	ソースでアラームがクリアされた日時。データタイプ：文字列テーブル:イベント [em_events] テーブルの [イベントの時刻] フィールド内。
clearSystemId	alarmCleared操作が呼び出されたインスタンスの名前。データタイプ：文字列
clearUserId	alarmCleared操作を呼び出したユーザーの一意の ID。データタイプ：文字列
href	アラームの URL。データタイプ：文字列
ID	一意の ID。データタイプ：文字列テーブル:イベント [em_events] テーブルのレコードの [メッセージキー] フィールド内。

cURL 要求

この例では、アラームをクリアします。

curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"alarmClearedTime\": \"2017-08-15 06:04:15\",
  \"clearSystemId\": \"<source_instance_name>\",
  \"clearUserId\": \"SOURCE_SYSTEM_vManage_00000_000_00\" 
}" \
--user 'user':'password'

応答本文。

{
  "result": {
    "alarmClearedTime": "2017-08-15 06:04:15",
    "clearSystemId": "<source_instance_name>",
    "clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00",
    "id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
  }
}