Web サービス API を使用したインスタンスへのイベントのプッシュ

データの入出力形式として JSON オブジェクトで動作する Web サービスインターフェイス (ServiceNow によってサポートされている) を使用できます。

始める前に

必要なロール：evt_mgmt_integration

このタスクについて

単一の呼び出しでイベント [em_event] テーブルにレコードを挿入するには、次の Web サービス API を使用します。

https://<instancename>.service-now.com/api/global/em/jsonv2

注:

この URL が使用されている場合、イベントテーブルのビジネスルールは呼び出されません。

イベントに追加フィールドを追加するためにイベントテーブル [em_event] テーブルにカスタムフィールドを追加するのはやめてください。ただし、追加のフィールドは、イベントの [追加情報] [additional_info] フィールドに含める必要があります。追加フィールドをイベントに含める方法の詳細については、「カスタムアラートフィールド」を参照してください。

ビジネスルールを有効にしたい場合は、http://<instancename>.service-now.com/em_event.do?JSONv2&sysparm_action=insertMultiple 形式の URL もサポートされています。ただし、最初の URL の方がパフォーマンスは優れています。

「=insertMultiple」で終わる URL を操作するには、次のプロパティをそれぞれの値とともに MID サーバーに追加します。

• "mid.probe.event.queue.compress" - 値：false
• "mid.probe.event.bulk_size" - 値：100
• "mid.probe.event.endpoint.url" - 値：em_event.do?JSONv2%26sysparm_action=insertMultiple

手順

1. 次のヘッダーを使用して要求を送信します。

   パラメーター	タイプ	説明
   承認	文字列	このメッセージの許容可能なタイプ。 デフォルト値は application/json です。
   Content-Type	文字列	このメッセージのコンテンツタイプ。 デフォルト値は application/json です。
   POST	文字列	要求タイプは POST で、後続するレコードが 1 つ以上あります。

2. 1 つ以上の JSON 形式のイベントを Web サービス呼び出しのペイロードとして送信できます。
   入力する必要があるイベントフィールド：

   変数	説明
   ソース	イベントソースタイプの名前。たとえば、SCOM、SolarWinds など。
   ソースインスタンス (event_class)	source の特定のインスタンス。たとえば、SCOM 2012 on 10.20.30.40
   node	[ノード] フィールドには、イベントをトリガーしたホスト (サーバー/スイッチ/ルーターなど) の識別子が含まれている必要があります。[ノード] フィールドの値は、ホストの次の識別子のいずれかになります。 名前 FQDN IP MAC アドレス これが CMDB に存在する場合、この値は、対応する ServiceNow CI にイベントをバインドするのにも使用されます。
   resource	イベントがデバイス (ディスク、CPU、ネットワークアダプターなど) を参照している場合、またはホスト上で実行されているアプリケーションまたはサービスを参照している場合は、デバイスまたはアプリケーションの名前をこのフィールドに入力する必要があります。たとえば、Disk C:\、Nic 001、Trade web application など。
   em_event.metric_name	アラートをトリガーしたメトリクスの名前。たとえば、Used Memory、Total CPU utilization など。
   type	イベントのタイプ。このタイプは、metric_name フィールドと似ている場合がありますが、イベントタイプの一般的なグループ化に使用されます。
   message_key	この値は、イベントの重複排除に使用されます。たとえば、同じ CI に 2 つのイベントが存在し、1 つのイベントの CPU が 50% で、次のイベントの CPU が 99% である場合が考えられます。両方のイベントを同じ ServiceNow アラートにマッピングする必要がある場合は、同じメッセージキーを使用する必要があります。フィールドは空のままにすることができ、その場合、フィールド値はデフォルトで source+node+type+resource+metric_name になります。message_key を設定する必要があるのは、デフォルト値よりも適した識別子がある場合のみです。
   severity	イベントの重大度。1 (重大) から 5 (OK) までの ServiceNow の重大度の値。重大度 0 は「クリア」です。元の重大度の値は、追加情報の一部として送信する必要があります。
   additional_info	このフィールドは JSON キー/値形式で、ユーザーに役立つ可能性のある情報の入力に使用されます。事前定義された ServiceNow イベントフィールドにはマッピングされません。例として、イベントソース内のオブジェクトの ID、イベント優先度 (重大度と異なる場合)、アサイン先グループ情報などがあります。JSON キー/値形式でないイベントの [追加情報] フィールドの値は、イベントが処理されると JSON 形式に正規化されます。
   time_of_event	イベントの発生元でイベントが発生した時間。形式：yyyy-MM-dd HH:mm:ss 指定する時間は GMT に基づいたものである必要があります。
   resolution_state	オプション：イベントが解決されたか、発生しなくなったことを示すために、一部のイベントモニターは「クリア」重大度を使用し、その他のイベントモニターは「クローズ」重大度の値を使用します。このフィールドは、「クローズ」重大度を提示するモニターで使用されます。有効な値は [新規] または [クローズ中] です。

3. 単一の呼び出しで複数のレコードを作成するには、次の URL を使用してイベント Web サービスをトリガーします。ここで、<instancename> 変数は、必要なインスタンスの名前に置き換えられます。
   https://<instancename>.service-now.com/api/global/em/jsonv2
   単一の Web サービス呼び出しで送信される 2 つのイベントのペイロードを示す例：

   { "records":	
    [
     {
      "source":"SCOM",
      "event_class":"SCOM 2012 on scom.server.com",
      "resource":"D:",
      "node":"name.of.node.com",
      "metric_name":"Percentage Logical Disk Free Space",
      "type":"Disk space",
      "severity":"4",
      "description":"The disk D: on computer V-W2K8-abc.abc.com is running out of disk space. The value that exceeded the threshold is 38% free space.",
      "additional_info": '{"scom-severity":"Medium","metric-value":"38","os_type":"Windows.Server.2008"}'
      },
     {
      "source":"SCOM",
      "event_class":"SCOM 2012 on scom.server.com",
      "resource":"MSSQL-database-name",
      "node":"other.node.com",
      "metric_name":"DB Allocated Size (MB)",
      "type":"Database Storage",
      "severity":"3",
      "description":"High number of active connections for MSSQL-database-name running on name.of.node.com. Active connections exceed 5000.",
      "additional_info": '{"scom-severity":"Medium","metric-value":"38","os_type":"Windows.Server.2008"}'
     }
    ]
   }

4. 単一の呼び出しで 1 つのレコードを作成するには、次の URL を使用してイベント Web サービスをトリガーします。ここで、<instancename> 変数は、必要なインスタンスの名前に置き換えられます。
   http://<instancename>.service-now.com/api/global/em/jsonv2
   単一の Web サービス呼び出しで送信される 1 つのイベントのペイロードを示す例：

   { "records":	
    [
     {
      "source":"SCOM",
      "event_class":"SCOM 2007 on scom.server.com",
      "resource":"C:",
      "node":"name.of.node.com",
      "metric_name":"Percentage Logical Disk Free Space",
      "type":"Disk space",
      "severity":"4",
      "description":"The disk C: on computer V-W2K8-dfg.dfg.com is running out of disk space. The value that exceeded the threshold is 41% free space.",
      "additional_info": '{"scom-severity":"Medium","metric-value":"38","os_type":"Windows.Server.2008"}'
     }     
    ]
   }

関連概念

• Web サービス API を使用した MID サーバー へのイベントのプッシュ