--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # アラーム管理オープン API # アラーム管理オープン API {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：56分 アラーム管理オープン API は、イベント \[em_event\] およびアラート \[em_alert\] テーブルからデータを作成、更新、および取得するためのエンドポイントを提供します。 テレコムアラーム管理オープン API (sn_ind_tmf642) は、TM Forum Open API 仕様の ServiceNow® 実装です。この API は、[TMF642 Alarm Management API REST Specification Release 20](https://www.tmforum.org/resources/specification/tmf642-alarm-management-api-user-guide-v4-0/) (2020 年 4 月) に基づいています。 呼び出し元ユーザーは、`sn_ind_tmf642.alarm_mgmt_integration` エンドポイントにアクセスする必要があります。 この API は `sn_ind_tmf642` 名前空間内で提供されます。 TM Forum Open API 仕様では、受信するすべてのインバウンド要求に対して同期応答が必要です。ペイロードをシステムに転送する前に、ソースの運用サポートシステム (OSS) で相関と重複排除を適用します。 この API を拡張して、必要なパラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングに関するカスタマイズを実行できます。詳細については、次を参照してください：[アラーム管理オープン API 開発者ガイド](https://servicenow-prod.fluidtopics.net/cNObJaZXKqvXMAdqmPzWLA#alarm-mgmt_dev-guide "アラーム管理オープン API を使用して、イベント [em_event] テーブルのデータを作成および更新します。")を参照してください。 アラーム管理オープン 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 | アラームが発せられた日付。日付がこのパラメーターの値に一致するアラームのみが応答で返されます。 データタイプ：文字列 | | fields | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： * alarmedObject * alarmRaisedTime * alarmType * crossedThresholdInformation * externalAlarmId * id * perceivedSeverity * probableCause * source * sourceSystemId * state * type {#alarm-GET-alarm__ul_n1h_htz_54b} デフォルト：すべてのフィールド データタイプ：文字列 | | id | アラーム ID。ID がこのパラメーターの値に一致するアラームのみが応答で返されます。イベント \[em_event\] テーブルの Message key フィールドにあります。 データタイプ：文字列 | | limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 デフォルト：1000 最大：2000 データタイプ：数値 | | offset | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 デフォルト：0 データタイプ：数値 | | probableCause | アラームの考えられる原因。考えられる原因がこのパラメーターの値に一致するアラームのみが応答で返されます。 データタイプ：文字列 | | state | アラームのステータス。ステータスがこのパラメーターの値に一致するアラームのみが応答で返されます。 データタイプ：文字列 | | sourceSystemId | アラームのソースシステム ID。ソースSys 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/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#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} | ヘッダー | 説明 | |-|-| | Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。 たとえば、`offset=2` および `limit=3` の場合、Content-Range ヘッダーの値は `items 3-5` です。 | | Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Link | クエリー結果内を移動するための次のリンクが含まれています。 * first * last * next * previous {#alarm-GET-alarm__ul_zzk_sdm_lsb} | | X-Total-Count | ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。 | [表 : 5. 応答ヘッダー] {#alarm-GET-alarm__table_c2r_4gm_lsb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#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 | アラームの影響を受ける 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 アラームリスト内のストレージのアラームレポート時間です。 {#alarm-GET-alarm__ul_mbt_1rf_ynb} データタイプ：文字列 | | alarmType | アラームカテゴリ。 データタイプ：文字列 | | crossedThresholdInformation | 超過したしきい値に関する詳細。 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } データタイプ：オブジェクト | | crossedThresholdInformation.direction | しきい値交差方向。 可能な値： * UP * DOWN {#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 | アラームペイロードをイベントとして識別して処理するシステムの一意の識別子。 データタイプ：文字列 | | perceivedSeverity | アラームの重大度。 可能な値： * CLEAR * CRITICAL * MAJOR * MINOR * 警告 {#alarm-GET-alarm__ul_vcp_c4f_ynb} データタイプ：文字列 | | plannedOutageIndication | このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。 データタイプ：文字列 | | probableCause | アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。 データタイプ：文字列 | | proposedRepairActions | システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。 データタイプ：文字列 | | serviceAffecting | アラームがサービスに影響を与えるかどうかを示すフラグ。 有効な値： * true：アラームはサービスパフォーマンスまたは可用性に影響します。 * false：アラームはサービスに影響しません。 {#alarm-GET-alarm__ul_omz_dnf_ynb} デフォルト値：false データタイプ：ブーリアン | | sourceSystemId | ソースアラームのインスタンス ID。 データタイプ：文字列 | | specificProblem | アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。 データタイプ：文字列 | | state | アラームのステータス。 有効な値： * 準備完了 * 処理済み * 無視 * エラー {#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\] テーブルの Message key フィールドにあります。 データタイプ：文字列 | [表 : 7. パスパラメーター] {#alarm-GET-alarm-id__entry__6} | 名前 | 説明 | |-|-| | fields | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： * alarmedObject * alarmRaisedTime * alarmType * crossedThresholdInformation * externalAlarmId * id * perceivedSeverity * probableCause * source * sourceSystemId * state * type {#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/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#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/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#alarm-GET-alarm-id__entry__22}{#alarm-GET-alarm-id__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。次の 1 つ以上の理由で、不適切な要求タイプまたは誤った形式の要求が検出されました。 * 無効なパスパラメーター。 * 無効な 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 | アラームの影響を受ける 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 アラームリスト内のストレージのアラームレポート時間です。 {#alarm-GET-alarm-id__ul_mbt_1rf_ynb} データタイプ：文字列 | | alarmType | アラームカテゴリ。 データタイプ：文字列 | | crossedThresholdInformation | 超過したしきい値に関する詳細。 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } データタイプ：オブジェクト | | crossedThresholdInformation.direction | しきい値交差方向。 可能な値： * UP * DOWN {#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 | アラームペイロードをイベントとして識別して処理するシステムの一意の識別子。 データタイプ：文字列 | | perceivedSeverity | アラームの重大度。 可能な値： * CLEAR * CRITICAL * MAJOR * MINOR * 警告 {#alarm-GET-alarm-id__ul_vcp_c4f_ynb} データタイプ：文字列 | | plannedOutageIndication | このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。 データタイプ：文字列 | | probableCause | アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。 データタイプ：文字列 | | proposedRepairActions | システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。 データタイプ：文字列 | | serviceAffecting | アラームがサービスに影響を与えるかどうかを示すフラグ。 有効な値： * true：アラームはサービスパフォーマンスまたは可用性に影響します。 * false：アラームはサービスに影響しません。 {#alarm-GET-alarm-id__ul_omz_dnf_ynb} デフォルト値：false データタイプ：ブーリアン | | sourceSystemId | ソースアラームのインスタンス ID。 データタイプ：文字列 | | specificProblem | アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。 データタイプ：文字列 | | state | アラームのステータス。 有効な値： * 準備完了 * 処理済み * 無視 * エラー {#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\] テーブルの Message key フィールドにあります。 データタイプ：文字列 | [表 : 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 | アラームの影響を受ける 1 つ以上のサービスを識別するオブジェクトのリスト。 データタイプ：アレイ "affectedService":[ { "href": "String", "id": "String" }, ] | | affectedService.href | 影響を受けるサービスの詳細を提供する URL 参照。 データタイプ：文字列 | | affectedService.id | 必須。 アラームの影響を受けるサービスの識別子。この値は、アラートの影響を受ける構成アイテム (CI) にマップされます。 データタイプ：文字列 | | alarmChangedTime | アラーム所有システムでアラームが最後に変更された日時を示します。アラームが変更されると、アラームが指定されたリソースからの変更であるか、クライアントからの変更によってトリガーされたものであるかにかかわらず、この値が更新されます。 データタイプ：文字列 | | alarmDetails | アラームに関するその他の詳細。 データタイプ：文字列 | | alarmEscalation | アラームの重大度のエスカレーションを示すフラグ。 有効な値： * 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" } データタイプ：オブジェクト | | crossedThresholdInformation.direction | しきい値交差方向。 可能な値： * UP * DOWN {#alarm-PATCH__ul_fsb_jlg_ynb} データタイプ：文字列 | | crossedThresholdInformation.granularity | しきい値の超過についてインジケーターが評価される粒度。たとえば、 `5MINUTES` などです。 データタイプ：文字列 | | crossedThresholdInformation.indicatorName | アラームしきい値を超えるインジケーターの名前。 データタイプ：文字列 | | crossedThresholdInformation.indicatorUnit | 超過したしきい値に対応するインジケーターの測定単位。 データタイプ：文字列 | | crossedThresholdInformation.observedValue | しきい値を超えるインジケーターを識別する番号。 データタイプ：文字列 | | crossedThresholdInformation.thresholdCrossingDescription | しきい値超過アラームのしきい値の詳細。 データタイプ：文字列 | | crossedThresholdInformation.thresholdId | 必須です。 アラームを発生させたしきい値の一意の識別子。 データタイプ：文字列 | | crossedThresholdInformation.thresholdRef | しきい値オブジェクトの URL。 データタイプ：文字列 | | href | アラームへの URL 参照。 データタイプ：文字列 | | perceivedSeverity | 必須です。アラームの重大度。 可能な値： * CLEAR * CRITICAL * MAJOR * MINOR * 警告 {#alarm-PATCH__ul_vcp_c4f_ynb} データタイプ：文字列 | | plannedOutageIndication | このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。 データタイプ：文字列 | | probableCause | 必須。 アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。 データタイプ：文字列 | | proposedRepairActions | システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。 データタイプ：文字列 | | serviceAffecting | アラームがサービスに影響を与えるかどうかを示すフラグ。 有効な値： * true：アラームはサービスパフォーマンスまたは可用性に影響します。 * false：アラームはサービスに影響しません。 {#alarm-PATCH__ul_omz_dnf_ynb} デフォルト値：false データタイプ：ブーリアン | | specificProblem | アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。 データタイプ：文字列 | [表 : 15. 要求本文パラメーター (JSON)] {#alarm-PATCH__table_kmr_mjs_xnb} ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#alarm-PATCH__entry__56}{#alarm-PATCH__accept-JSON-only-entry-RESTAPI}{#alarm-PATCH__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。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/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#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 でアラームが変更された日時。この値は GlideDateTime 形式で、Events \[em_events\] テーブルのレコードの Time of event フィールドにあります。この値は、アラームが指定されたリソースからのアラームへの変更が発生した場合、またはクライアント更新による変更によってアラームがトリガーされた場合に更新されます。 この値は応答で必須です。 データタイプ：文字列 | | href | アラームへの URL 参照。 データタイプ：文字列 | | id | アラームの一意の識別子。アラームを所有するシステムによって決定される値。 データタイプ：文字列 | [ ] ### cURL 要求 この例では、重大度が MINOR に下がっています。 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=xanadu&pubname=xanadu-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 | アラームの影響を受ける 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 アラームリスト内のストレージのアラームレポート時間です。 {#alarm-POST-create__ul_mbt_1rf_ynb} データタイプ：文字列 | | alarmType | 必須です。 アラームカテゴリ。 データタイプ：文字列 | | crossedThresholdInformation | 超過したしきい値に関する詳細。 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } データタイプ：オブジェクト | | crossedThresholdInformation.direction | しきい値交差方向。 可能な値： * UP * DOWN {#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 を生成し、応答ペイロードの一部として送信します。 データタイプ：文字列 | | perceivedSeverity | 必須です。アラームの重大度。 可能な値： * CLEAR * CRITICAL * MAJOR * MINOR * 警告 {#alarm-POST-create__ul_vcp_c4f_ynb} データタイプ：文字列 | | plannedOutageIndication | このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。 データタイプ：文字列 | | probableCause | 必須。 アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。 データタイプ：文字列 | | proposedRepairActions | システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。 データタイプ：文字列 | | serviceAffecting | アラームがサービスに影響を与えるかどうかを示すフラグ。 有効な値： * true：アラームはサービスパフォーマンスまたは可用性に影響します。 * false：アラームはサービスに影響しません。 {#alarm-POST-create__ul_omz_dnf_ynb} デフォルト値：false データタイプ：ブーリアン | | sourceSystemId | 必須です。 ソースアラームのインスタンス ID。 データタイプ：文字列 | | specificProblem | アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。 データタイプ：文字列 | | state | アラームのステータス。 有効な値： * 準備完了 * 処理済み * 無視 * エラー {#alarm-POST-create__ul_ilh_3jt_xnb}無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。 ステータスが `[準備完了]` の場合、アラート \[em_alert\] テーブルにアラートが作成され、ステータスは `[処理済み]` になります。ステータスが `[処理済み]`、`[無視]`、または `[エラー]` の場合、アラートは作成されません。 デフォルト値：準備完了 データタイプ：文字列 | [表 : 21. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#alarm-POST-create__entry__72}{#alarm-POST-create__accept-JSON-only-entry-RESTAPI}{#alarm-POST-create__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。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/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#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__d3018e79}{#alarm-POST-create__d3018e92}{#alarm-POST-create__d3018e411}{#alarm-POST-create__d3018e350} | 名前 | 説明 | |-|-| | 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 アラームリスト内のストレージのアラームレポート時間です。 {#alarm-POST-create__d3018e467} データタイプ：文字列 | | alarmType | アラームカテゴリ。 データタイプ：文字列 | | crossedThresholdInformation | 超過したしきい値に関する詳細。 "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } データタイプ：オブジェクト | | crossedThresholdInformation.direction | しきい値交差方向。 可能な値： * UP * DOWN {#alarm-POST-create__d3018e147} データタイプ：文字列 | | 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 * 警告 {#alarm-POST-create__d3018e256} データタイプ：文字列 | | plannedOutageIndication | このアラームの管理対象オブジェクトが計画された機能停止ステータスであることを示します。たとえば、計画メンテナンスやサービス停止などです。 データタイプ：文字列 | | probableCause | アラームをトリガーする可能性が最も高い状況。alarmType とともに使用してアラームを認定します。 データタイプ：文字列 | | proposedRepairActions | システムで利用可能な場合、アラームをトリガーする問題を解決する修正アクションを提供します。 データタイプ：文字列 | | serviceAffecting | アラームがサービスに影響を与えるかどうかを示すフラグ。 有効な値： * true：アラームはサービスパフォーマンスまたは可用性に影響します。 * false：アラームはサービスに影響しません。 {#alarm-POST-create__d3018e330} デフォルト値：false データタイプ：ブーリアン | | sourceSystemId | ソースアラームのインスタンス ID。 データタイプ：文字列 | | specificProblem | アラームをトリガーする特定の問題。probableCause とともに使用してアラームを認定します。 データタイプ：文字列 | | state | アラームのステータス。 有効な値： * 準備完了 * 処理済み * 無視 * エラー {#alarm-POST-create__d3018e556}無効な値が指定された場合、ステータスは `[準備完了]` に設定されます。 ステータスが `[準備完了]` の場合、アラート \[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} | 名前 | 説明 | |-|-| | alarmClearedTime | ソースでアラームがクリアされた日時。この値は、イベント \[em_events\] テーブルのレコードの Time of event フィールドにあります。 データタイプ：文字列 | | clearSystemId | 必須です。 alarmCleared 操作が呼び出されたインスタンスの名前。 データタイプ：文字列 | | clearUserId | 必須です。 alarmCleared操作を呼び出したユーザーの一意の ID。この値は、イベント \[em_events\] テーブルのレコードの Source フィールドにあります。 データタイプ：文字列 | [表 : 27. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#alarm-POST-clear__entry__18}{#alarm-POST-clear__accept-JSON-only-entry-RESTAPI}{#alarm-POST-clear__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 28. 要求ヘッダー] {#alarm-POST-clear__entry__24} | 名前 | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#alarm-POST-clear__entry__28} | ステータスコード | 説明 | |-|-| | 201 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。 考えられる理由： * 無効なペイロード。必須のアラーム ID がありません。 * 無効なペイロード。必須フィールドがありません：\ 。 * 無効なペイロード。必須のオブジェクトがありません。 * イベントが作成されませんでした。失敗しました。 * イベントをクリアできません。 * イベントを更新できません。 * イベントが存在しません。 {#alarm-POST-clear__ul_f4x_sdb_ynb} | [表 : 30. ステータスコード] ### 応答本文のパラメーター (JSON) {#alarm-POST-clear__entry__34} | 名前 | 説明 | |-|-| | 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://.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_" } }