ヘルプ URL/REST API 呼び出し

URL/REST API 呼び出し

Invoke URL/REST APIで、Site24x7イベントデータを複数のサードパーティ製アプリケーションに接続することで、ITワークフローを自動化できます。Webhookは、「ユーザーが定義するHTTPコールバックアクション」であり、イベントベースの出力メカニズムとして機能します。Site24x7を使用して、監視ステータスや属性変更などの特定イベントを定義できます。また、Site24x7でインシデントまたはイベントが発生すると、ユーザーが指定したHook URLへイベントデータが送信されます。Invoke URL/REST APIアクションは、監視または属性レベルでマッピングできます。停止の監視に関連付けられたインシデントおよびカスタムパラメータを、POSTED URLの本文とともに送信することもできます。

コンテンツ

ユースケース:

Invoke URL/REST APIを介して実行されるタスクは、サードパーティのインシデント管理ツールまたはチームコラボレーションソフトウェアでの、Site24x7インシデント、アラート、メッセージの管理と合理化です。これにより、チームのコラボレーションが大幅に改善され、スタッフの生産性が向上します。

  • ダッシュボードでSite24x7アラートを処理するため、PagerDuty、VictorOpsなどのサードパーティ製ソフトウェアと連携します。
  • SlackやHipChatなどのアプリケーションを使用し、強力なワークフローを構築します。Site24x7インシデントの停止を、SlackチャンネルまたはHipChatルームのメッセージとして投稿できます。

URL/REST API 呼び出しの設定

  1. Site24x7にログインします。
  2. ［管理］ > ［設定プロファイル］ >［ITオートメーション］ > ［オートメーションの追加］へ移動します。
  3. ［オートメーション］タイプとしてInvoke URL/REST APIを選択します。
  4. 次の情報を入力し、Invoke URL/REST APIを設定します。
    • 表示名: 指定したアクションの識別名を入力します。
      例: サーバーの再起動
    • URL: 目的のアクションをトリガーするURLを指定します。
    • HTTPメソッド: サイトへの接続で使用するCRUDメソッドを指定します。Site24x7では、GET、POST、PUT、PATCH、DELETEメソッドをサポートしています。
      POST、PUT、PATCH、DELETE HTTPメソッドでのリクエスト送信では、JSON形式をサポートしています。
    • HTTPリクエストヘッダー: デフォルトのHTTPリクエストのヘッダー情報をカスタマイズしたい場合は、ここでヘッダー名とヘッダー値の追加ができます。
    • ユーザーエージェント: リクエストおよびHTTPヘッダーを送信するため、カスタマイズされたユーザーエージェント（Webブラウザー）を設定します。利用可能なユーザーエージェントの中から選択できます。
      invoke-url-json
    • 認証方法: ラジオボタンを押し、認証情報を更新します。
      • Basic/NTLM認証: Basic/NTLMベースの認証を設定します。Windows NTLMは、Windows OSで稼働しているシステム上の認証プロトコルです。
        認証情報: Basic/NTLMベースの認証が必要なURLの、ユーザー名およびパスワードを指定します。
      • OAuth: OAuthフレームワークで保護されたリソースを監視している場合、［OAuth］ラジオボタンをクリックします。
        プロバイダー名: 設定済みリストからOAuthプロバイダー名を選択するか、「+」ボタンをクリックし、新規OAuthプロファイルを作成します。
        OAuthプロバイダーの設定方法は、こちらをご覧ください。
    • インシデントパラメーターの送信: このオプションを選択すると、停止の監視に関連したインシデントパラメーターが、POST URLの本文とともに送信されます。インシデントパラメーターについての詳細はこちらをご覧ください。
      インシデントパラメーターは、監視に関連付けられた実際のステータスまたは属性の変更がある場合にのみPOST URLとともに送信されます。ITオートメーションのテスト中は、インシデントパラメーターは送信されません。
      incident-parameters
    • カスタムパラメーターの送信: POSTおよびGET HTTPメソッドのパラメーターを送信する特定コードを、Param name=値のペア形式で書き込みます。リクエストは、JSON形式でPOSTできます。HTTPリクエストでカスタムパラメーターを送信する際に、「名前」または「値」フィールドに定義済みグローバルパラメーターを指定することができます。グローバルパラメーターは、HTTPレスポンスで定義された定数または実際の動的値で置き換えられます。カスタムパラメーターは、次の構文のいずれかを使用して送信する必要があります。
JSON形式で指定されている場合のカスタムパラメーターの構文:
invoke-url-json-form
JSON形式で指定されていない場合のカスタムパラメーターの構文
invoke-url-not-json
  • タイムアウト: Webサイトが応答しない状態とみなされるまでの、Site24x7サーバーの待機時間を表示します(単位:秒)。デフォルトで設定されているタイムアウト時間は、15秒です。タイムアウト値は、1∼90秒の間で限定します。
  • オートメーション結果をメールで送信: 通知プロファイルで設定したユーザーアラートグループに、オートメーション結果をメールで共有することができます。
  • 保存をクリックします。

オートメーションのテスト

Invoke URL/REST APIを設定後、［ITオートメーションのサマリー］ページへ移動し（［管理］ >［プロファイルの設定］ >［ITオートメーション］）、play-buttonアイコンをクリックしてテストを実行します。 詳細はこちら

[ITオートメーションログ]をクリックすると、実行したオートメーションのリストが日付別に表示されます。

Invoke URL/REST APIの呼び出し中に、インシデントパラメータおよびカスタムパラメータを送信します:

例えば、カスタムパラメータ名:値のペアとして使用するグローバルパラメーターのセットを定義した場合。POSTED URLの本文には、送信するカスタムパラメーターを入力します。

global-parameters-listed
指定した監視ステータスまたは属性の変更に対してInvoke URL/REST APIを実行すると、次のカスタムパラメーターもURL本文に送信されます。次のスクリーンショットの下部では、グローバルパラメーター値がHTTPレスポンスの定数または動的値に置き換えられています。なお、これはテスト呼び出しであるため、定義済みのカスタムパラメーターとともにインシデントパラメーターは送信されません。

invoke-url-result

ただし、次の例では、HTTPリクエストに対するJSONレスポンスが明確に強調表示され、ユーザーが指定したすべてのカスタムパラメーター値とともに送信された実際のインシデントパラメーターが表示されています。

incident-custom-params-invoke-url

オートメーションとイベントの関連付け

オートメーションを実行するには、任意の監視または属性にマッピングします。マッピングの方法は、次の2通りあります。

属性（監視レベル および Childレベル）ごとに、最大5つのオートメーションを関連付けることができます。

サポートしているオートメーションのリスト: