API インテグレーションを作成する
概要
統合でできるようになること
API 統合により、Opsgenie サービスにアクセスして、アラートを作成したり、サードパーティ アプリのユーザー、オンコール スケジュール、チームを設定したりできます。
統合による機能
既定の API 統合は、Opsgenie アカウントに付属しています。この統合を使用して、ユーザーやアラートを設定できます。ただし、監視システムごとに個別の API 統合を追加することをお勧めします。
Opsgenie には、設定を容易にする多くの管理システムと統合する機能が組み込まれています。API 統合を使用する前に、サポートされているアプリの現在のリストをご確認ください。探しているものが見つからない場合は、こちらまでお問い合わせください。
Opsgenie クライアント ツール
HTTPS/JSON リクエストを送信できるソフトウェア システム。
統合をセットアップする
API 統合を追加する
[設定] > [統合] の順に移動します。
検索を実行して「API」を選択します。
次の画面で、統合の名前を入力します。
オプション: 特定のチームが統合からのアラートを受信するようにする場合は、[Assignee team (担当者チーム)] のチームを選択します。 Opsgenie でのアラート通知のフローをご確認ください。
[Continue] を選択します。
この時点で、統合が保存されます。[統合を設定するステップ] セクションを展開して、API リクエストで使用する API キーをコピーします。
[統合をオンにする] を選択します。
統合のために作成したルールは、統合をオンにした場合にのみ機能します。
Opsgenie の Free プランまたは Essentials プランを使用している、または Jira Service Management の Standard プランで Opsgenie を使用している場合は、チーム ダッシュボードからのみこの統合を追加できます。 このプランでは、[設定] の [統合] ページが利用できません。
[チーム] に移動して自分のチームを選択します。
左側のナビゲーションで [統合] を選択し、[統合を追加] を選択します。
統合をチーム ダッシュボードから追加すると、そのチーム統合の所有者になります。Opsgenie では、この統合を通じて受信したアラートはそのチームのみに割り当てられます。このセクションの残りの手順に従って、統合を設定してください。
Opsgenie アカウントの所有者がメールをまだ確認していない場合、組織内のユーザーは API 統合を使用できるようになりません。
アラートの作成と処理のルールを定義する
API 統合設定には、さまざまなアラート シナリオの定義が含まれます。これらのシナリオでは、アラートの作成、クローズ、承認などの方法とタイミングを指定します。統合には、アラート作成および処理ルールの既定のセットが付属しています。それらをカスタマイズして、必要なだけ独自のルールを追加できます。たとえば、アラート作成に 3 つのルールを追加できます。この場合、受信データがこれらの 3 つのシナリオに対して順に評価され、そのうちの 1 つのルールに一致すれば、アラートが作成されます。ただし、API 統合の動作には若干の違いがあります。他の統合とは異なり、使用している特定のエンドポイントのルールのみが考慮されます。たとえば、「アラートをクリア」リクエストを送信すると、「アラートを作成」セクションのルールのみがチェックされ、他のアラート処理ルールがある場合はそれと一致させようとしてカスケードが続行されません。
動的フィールド (カスタム優先度、ペイロード、URL、ヘッダー) は API インテグレーションでは使用できません。
この内容はお役に立ちましたか?