アラーム管理オープン API

リリースバージョン: Xanadu

更新日 2024年08月01日

所要時間：56分

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

テレコムアラーム管理オープン API (sn_ind_tmf642) は、TM Forum Open API 仕様の ServiceNow® 実装です。この API は、TMF642 Alarm Management API REST Specification Release 20 (2020 年 4 月) に基づいています。

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

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

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

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

アラーム管理オープン 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. クエリパラメータ
名前	説明
alarmRaisedTime	アラームが発せられた日付。日付がこのパラメーターの値に一致するアラームのみが応答で返されます。データタイプ：文字列
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド： alarmedObject alarmRaisedTime alarmType crossedThresholdInformation externalAlarmId id perceivedSeverity probableCause source sourceSystemId state type デフォルト：すべてのフィールドデータタイプ：文字列
id	アラーム ID。ID がこのパラメーターの値に一致するアラームのみが応答で返されます。イベント [em_event] テーブルの Message key フィールドにあります。データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。デフォルト：1000 最大：2000 データタイプ：数値
offset	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。デフォルト：0 データタイプ：数値
probableCause	アラームの考えられる原因。考えられる原因がこのパラメーターの値に一致するアラームのみが応答で返されます。データタイプ：文字列
state	アラームのステータス。ステータスがこのパラメーターの値に一致するアラームのみが応答で返されます。データタイプ：文字列
sourceSystemId	アラームのソースシステム ID。ソースSys ID がこのパラメーターの値に一致するアラームのみが応答で返されます。データタイプ：文字列

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

ヘッダー

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

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

表 : 5. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。たとえば、`offset=2` および `limit=3` の場合、Content-Range ヘッダーの値は `items 3-5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
Link	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

この 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) にマップされます。データタイプ：文字列
alarmDetails	アラームに関するその他の詳細。データタイプ：文字列
alarmedObject	アラームオブジェクトの詳細。 `"alarmedObject": { "href": "String", "id": "String" }` データタイプ：オブジェクト
alarmedObject.id	アラームオブジェクトの一意の識別子。この値はシステム内の CI にマップされます。データタイプ：文字列
alarmedObject.href	アラームオブジェクトの詳細を取得するための URL 参照。データタイプ：文字列
alarmedObjectType	イベントに関連付けられたオブジェクトのタイプまたはクラス。データタイプ：文字列
alarmRaisedTime	ソースでアラームが発生した日時。データタイプ：文字列
alarmReportingTime	OSS がアラームをレポートする日時。この値は alarmRaisedTime 値と異なる場合があります。たとえば、要素管理システム (EMS) がアラームリストを管理している場合： alarmRaisedTime は、ネットワーク要素 (NE) によるアラーム検出の時間です。 alarmReportingTime は、EMS アラームリスト内のストレージのアラームレポート時間です。データタイプ：文字列
alarmType	アラームカテゴリ。データタイプ：文字列
crossedThresholdInformation	超過したしきい値に関する詳細。 `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` データタイプ：オブジェクト
crossedThresholdInformation.direction	しきい値交差方向。可能な値： UP DOWN データタイプ：文字列
crossedThresholdInformation.granularity	しきい値の超過についてインジケーターが評価される粒度。たとえば、 `5MINUTES` などです。データタイプ：文字列
crossedThresholdInformation.indicatorName	アラームしきい値を超えるインジケーターの名前。データタイプ：文字列
crossedThresholdInformation.indicatorUnit	超過したしきい値に対応するインジケーターの測定単位。データタイプ：文字列
crossedThresholdInformation.observedValue	しきい値を超えるインジケーターを識別する番号。データタイプ：文字列
crossedThresholdInformation.thresholdCrossingDescription	しきい値超過アラームのしきい値の詳細。データタイプ：文字列
crossedThresholdInformation.thresholdId	アラームを発生させたしきい値の一意の識別子。データタイプ：文字列
crossedThresholdInformation.thresholdRef	しきい値オブジェクトの URL。データタイプ：文字列
externalAlarmId	アラームを投稿しているソースシステムからのアラームの一意の識別子。データタイプ：文字列
href	リソースの URL。データタイプ：文字列
id	アラームペイロードをイベントとして識別して処理するシステムの一意の識別子。データタイプ：文字列
perceivedSeverity	アラームの重大度。可能な値： CLEAR CRITICAL MAJOR MINOR 警告データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。データタイプ：文字列
probableCause	アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。データタイプ：文字列
proposedRepairActions	システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響を与えるかどうかを示すフラグ。有効な値： true：アラームはサービスパフォーマンスまたは可用性に影響します。 false：アラームはサービスに影響しません。デフォルト値：false データタイプ：ブーリアン
sourceSystemId	ソースアラームのインスタンス ID。データタイプ：文字列
specificProblem	アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。データタイプ：文字列
state	アラームのステータス。有効な値：準備完了処理済み無視エラー無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。ステータスが `[準備完了]` の場合、アラート [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] テーブルの Message key フィールドにあります。データタイプ：文字列

表 : 8. クエリパラメーター
名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド： alarmedObject alarmRaisedTime alarmType crossedThresholdInformation externalAlarmId id perceivedSeverity probableCause source sourceSystemId state 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) にマップされます。データタイプ：文字列
alarmDetails	アラームに関するその他の詳細。データタイプ：文字列
alarmedObject	アラームオブジェクトの詳細。データタイプ：オブジェクト `"alarmedObject": { "href": "String", "id": "String" }`
alarmedObject.id	アラームオブジェクトの一意の識別子。この値はシステム内の CI にマップされます。データタイプ：文字列
alarmedObject.href	アラームオブジェクトの詳細を取得するための URL 参照。データタイプ：文字列
alarmedObjectType	イベントに関連付けられたオブジェクトのタイプまたはクラス。データタイプ：文字列
alarmRaisedTime	ソースでアラームが発生した日時。データタイプ：文字列
alarmReportingTime	OSS がアラームをレポートする日時。この値は alarmRaisedTime 値と異なる場合があります。たとえば、要素管理システム (EMS) がアラームリストを管理している場合： alarmRaisedTime は、ネットワーク要素 (NE) によるアラーム検出の時間です。 alarmReportingTime は、EMS アラームリスト内のストレージのアラームレポート時間です。データタイプ：文字列
alarmType	アラームカテゴリ。データタイプ：文字列
crossedThresholdInformation	超過したしきい値に関する詳細。 `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` データタイプ：オブジェクト
crossedThresholdInformation.direction	しきい値交差方向。可能な値： UP DOWN データタイプ：文字列
crossedThresholdInformation.granularity	しきい値の超過についてインジケーターが評価される粒度。たとえば、 `5MINUTES` などです。データタイプ：文字列
crossedThresholdInformation.indicatorName	アラームしきい値を超えるインジケーターの名前。データタイプ：文字列
crossedThresholdInformation.indicatorUnit	超過したしきい値に対応するインジケーターの測定単位。データタイプ：文字列
crossedThresholdInformation.observedValue	しきい値を超えるインジケーターを識別する番号。データタイプ：文字列
crossedThresholdInformation.thresholdCrossingDescription	しきい値超過アラームのしきい値の詳細。データタイプ：文字列
crossedThresholdInformation.thresholdId	アラームを発生させたしきい値の一意の識別子。データタイプ：文字列
crossedThresholdInformation.thresholdRef	しきい値オブジェクトの URL。データタイプ：文字列
externalAlarmId	アラームを投稿しているソースシステムからのアラームの一意の識別子。データタイプ：文字列
href	リソースの URL。データタイプ：文字列
id	アラームペイロードをイベントとして識別して処理するシステムの一意の識別子。データタイプ：文字列
perceivedSeverity	アラームの重大度。可能な値： CLEAR CRITICAL MAJOR MINOR 警告データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。データタイプ：文字列
probableCause	アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。データタイプ：文字列
proposedRepairActions	システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響を与えるかどうかを示すフラグ。有効な値： true：アラームはサービスパフォーマンスまたは可用性に影響します。 false：アラームはサービスに影響しません。デフォルト値：false データタイプ：ブーリアン
sourceSystemId	ソースアラームのインスタンス ID。データタイプ：文字列
specificProblem	アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。データタイプ：文字列
state	アラームのステータス。有効な値：準備完了処理済み無視エラー無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。ステータスが `[準備完了]` の場合、アラート [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] テーブルの Message key フィールドにあります。データタイプ：文字列

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

表 : 15. 要求本文パラメーター (JSON)
名前	説明
affectedService	アラームの影響を受ける 1 つ以上のサービスを識別するオブジェクトのリスト。データタイプ：アレイ `"affectedService":[ { "href": "String", "id": "String" }, ]`
affectedService.href	影響を受けるサービスの詳細を提供する URL 参照。データタイプ：文字列
affectedService.id	必須。アラームの影響を受けるサービスの識別子。この値は、アラートの影響を受ける構成アイテム (CI) にマップされます。データタイプ：文字列
alarmChangedTime	アラーム所有システムでアラームが最後に変更された日時を示します。アラームが変更されると、アラームが指定されたリソースからの変更であるか、クライアントからの変更によってトリガーされたものであるかにかかわらず、この値が更新されます。データタイプ：文字列
alarmDetails	アラームに関するその他の詳細。データタイプ：文字列
alarmEscalation	アラームの重大度のエスカレーションを示すフラグ。有効な値： true：アラームの重大度にエスカレーションがあります。 false：アラームの重大度は同じかそれ以下です。デフォルト値：false データタイプ：ブーリアン
crossedThresholdInformation	超過したしきい値に関する詳細。 `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` データタイプ：オブジェクト
crossedThresholdInformation.direction	しきい値交差方向。可能な値： UP DOWN データタイプ：文字列
crossedThresholdInformation.granularity	しきい値の超過についてインジケーターが評価される粒度。たとえば、 `5MINUTES` などです。データタイプ：文字列
crossedThresholdInformation.indicatorName	アラームしきい値を超えるインジケーターの名前。データタイプ：文字列
crossedThresholdInformation.indicatorUnit	超過したしきい値に対応するインジケーターの測定単位。データタイプ：文字列
crossedThresholdInformation.observedValue	しきい値を超えるインジケーターを識別する番号。データタイプ：文字列
crossedThresholdInformation.thresholdCrossingDescription	しきい値超過アラームのしきい値の詳細。データタイプ：文字列
crossedThresholdInformation.thresholdId	必須です。アラームを発生させたしきい値の一意の識別子。データタイプ：文字列
crossedThresholdInformation.thresholdRef	しきい値オブジェクトの URL。データタイプ：文字列
href	アラームへの URL 参照。データタイプ：文字列
perceivedSeverity	必須です。アラームの重大度。可能な値： CLEAR CRITICAL MAJOR MINOR 警告データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。データタイプ：文字列
probableCause	必須。アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。データタイプ：文字列
proposedRepairActions	システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響を与えるかどうかを示すフラグ。有効な値： true：アラームはサービスパフォーマンスまたは可用性に影響します。 false：アラームはサービスに影響しません。デフォルト値：false データタイプ：ブーリアン
specificProblem	アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。データタイプ：文字列

ヘッダー

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

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

ステータスコード

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

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


名前	説明
alarmChangedTime	アラーム所有システムの GMT でアラームが変更された日時。この値は GlideDateTime 形式で、Events [em_events] テーブルのレコードの Time of event フィールドにあります。この値は、アラームが指定されたリソースからのアラームへの変更が発生した場合、またはクライアント更新による変更によってアラームがトリガーされた場合に更新されます。この値は応答で必須です。データタイプ：文字列
href	アラームへの URL 参照。データタイプ：文字列
id	アラームの一意の識別子。アラームを所有するシステムによって決定される値。データタイプ：文字列

cURL 要求

この例では、重大度が MINOR に下がっています。

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/alarm

イベント [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) にマップされます。データタイプ：文字列
alarmDetails	アラームに関するその他の詳細。データタイプ：文字列
alarmedObject	必須です。アラームオブジェクトの詳細。 `"alarmedObject": { "href": "String", "id": "String" }` データタイプ：オブジェクト
alarmedObject.id	必須です。アラームオブジェクトの一意の識別子。この値はシステム内の CI にマップされます。データタイプ：文字列
alarmedObject.href	アラームオブジェクトの詳細を取得するための URL 参照。データタイプ：文字列
alarmedObjectType	イベントに関連付けられたオブジェクトのタイプまたはクラス。データタイプ：文字列
alarmRaisedTime	ソースでアラームが発生した日時。データタイプ：文字列
alarmReportingTime	OSS がアラームをレポートする日時。この値は alarmRaisedTime 値と異なる場合があります。たとえば、要素管理システム (EMS) がアラームリストを管理している場合： alarmRaisedTime は、ネットワーク要素 (NE) によるアラーム検出の時間です。 alarmReportingTime は、EMS アラームリスト内のストレージのアラームレポート時間です。データタイプ：文字列
alarmType	必須です。アラームカテゴリ。データタイプ：文字列
crossedThresholdInformation	超過したしきい値に関する詳細。 `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` データタイプ：オブジェクト
crossedThresholdInformation.direction	しきい値交差方向。可能な値： UP DOWN データタイプ：文字列
crossedThresholdInformation.granularity	しきい値の超過についてインジケーターが評価される粒度。たとえば、 `5MINUTES` などです。データタイプ：文字列
crossedThresholdInformation.indicatorName	アラームしきい値を超えるインジケーターの名前。データタイプ：文字列
crossedThresholdInformation.indicatorUnit	超過したしきい値に対応するインジケーターの測定単位。データタイプ：文字列
crossedThresholdInformation.observedValue	しきい値を超えるインジケーターを識別する番号。データタイプ：文字列
crossedThresholdInformation.thresholdCrossingDescription	しきい値超過アラームのしきい値の詳細。データタイプ：文字列
crossedThresholdInformation.thresholdId	必須です。アラームを発生させたしきい値の一意の識別子。データタイプ：文字列
crossedThresholdInformation.thresholdRef	しきい値オブジェクトの URL。データタイプ：文字列
externalAlarmId	必須です。アラームを投稿しているソースシステムからのアラームの一意の識別子。データタイプ：文字列
id	アラームペイロードをイベントとして識別して処理するシステムの一意の識別子。ペイロードで使用する場合は、この値を空にする必要があります。システムはイベントに対してこの一意の ID を生成し、応答ペイロードの一部として送信します。データタイプ：文字列
perceivedSeverity	必須です。アラームの重大度。可能な値： CLEAR CRITICAL MAJOR MINOR 警告データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。データタイプ：文字列
probableCause	必須。アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。データタイプ：文字列
proposedRepairActions	システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響を与えるかどうかを示すフラグ。有効な値： true：アラームはサービスパフォーマンスまたは可用性に影響します。 false：アラームはサービスに影響しません。デフォルト値：false データタイプ：ブーリアン
sourceSystemId	必須です。ソースアラームのインスタンス ID。データタイプ：文字列
specificProblem	アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。データタイプ：文字列
state	アラームのステータス。有効な値：準備完了処理済み無視エラー無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。ステータスが `[準備完了]` の場合、アラート [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) にマップされます。データタイプ：文字列
alarmDetails	アラームに関するその他の詳細。データタイプ：文字列
alarmedObject	アラームオブジェクトの詳細。 `"alarmedObject": { "href": "String", "id": "String" }` データタイプ：オブジェクト
alarmedObject.id	アラームオブジェクトの一意の識別子。この値はシステム内の CI にマップされます。データタイプ：文字列
alarmedObject.href	アラームオブジェクトの詳細を取得するための URL 参照。データタイプ：文字列
alarmedObjectType	イベントに関連付けられたオブジェクトのタイプまたはクラス。データタイプ：文字列
alarmRaisedTime	ソースでアラームが発生した日時。データタイプ：文字列
alarmReportingTime	OSS がアラームをレポートする日時。この値は alarmRaisedTime 値と異なる場合があります。たとえば、要素管理システム (EMS) がアラームリストを管理している場合： alarmRaisedTime は、ネットワーク要素 (NE) によるアラーム検出の時間です。 alarmReportingTime は、EMS アラームリスト内のストレージのアラームレポート時間です。データタイプ：文字列
alarmType	アラームカテゴリ。データタイプ：文字列
crossedThresholdInformation	超過したしきい値に関する詳細。 `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` データタイプ：オブジェクト
crossedThresholdInformation.direction	しきい値交差方向。可能な値： UP DOWN データタイプ：文字列
crossedThresholdInformation.granularity	しきい値の超過についてインジケーターが評価される粒度。たとえば、 `5MINUTES` などです。データタイプ：文字列
crossedThresholdInformation.indicatorName	アラームしきい値を超えるインジケーターの名前。データタイプ：文字列
crossedThresholdInformation.indicatorUnit	超過したしきい値に対応するインジケーターの測定単位。データタイプ：文字列
crossedThresholdInformation.observedValue	しきい値を超えるインジケーターを識別する番号。データタイプ：文字列
crossedThresholdInformation.thresholdCrossingDescription	しきい値超過アラームのしきい値の詳細。データタイプ：文字列
crossedThresholdInformation.thresholdId	アラームを発生させたしきい値の一意の識別子。データタイプ：文字列
crossedThresholdInformation.thresholdRef	しきい値オブジェクトの URL。データタイプ：文字列
externalAlarmId	アラームを投稿しているソースシステムからのアラームの一意の識別子。データタイプ：文字列
href	リソースの URL。データタイプ：文字列
id	アラームペイロードをイベントとして識別して処理するシステムの一意の識別子。データタイプ：文字列
perceivedSeverity	アラームの重大度。可能な値： CLEAR CRITICAL MAJOR MINOR 警告データタイプ：文字列
plannedOutageIndication	このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。データタイプ：文字列
probableCause	アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。データタイプ：文字列
proposedRepairActions	システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。データタイプ：文字列
serviceAffecting	アラームがサービスに影響を与えるかどうかを示すフラグ。有効な値： true：アラームはサービスパフォーマンスまたは可用性に影響します。 false：アラームはサービスに影響しません。デフォルト値：false データタイプ：ブーリアン
sourceSystemId	ソースアラームのインスタンス ID。データタイプ：文字列
specificProblem	アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。データタイプ：文字列
state	アラームのステータス。有効な値：準備完了処理済み無視エラー無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。ステータスが `[準備完了]` の場合、アラート [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)
名前	説明
alarmClearedTime	ソースでアラームがクリアされた日時。この値は、イベント [em_events] テーブルのレコードの Time of event フィールドにあります。データタイプ：文字列
clearSystemId	必須です。 alarmCleared 操作が呼び出されたインスタンスの名前。データタイプ：文字列
clearUserId	必須です。 alarmCleared操作を呼び出したユーザーの一意の ID。この値は、イベント [em_events] テーブルのレコードの Source フィールドにあります。データタイプ：文字列

ヘッダー

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

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

ステータスコード

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

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


名前	説明
alarmClearedTime	ソースでアラームがクリアされた日時。この値は、イベント [em_events] テーブルのレコードの Time of event フィールドにあります。データタイプ：文字列
clearSystemId	alarmCleared 操作が呼び出されたインスタンスの名前。データタイプ：文字列
clearUserId	alarmCleared操作を呼び出したユーザーの一意の ID。この値は、イベント [em_events] テーブルのレコードの Source フィールドにあります。データタイプ：文字列
href	アラームの URL。データタイプ：文字列
id	イベント [em_events] テーブルのレコードの Message key フィールドにある一意の ID。データタイプ：文字列

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>"
  }
}