REST API v3 Swagger ドキュメント
最終更新日: 28 年 2024 月 XNUMX 日推奨事項： LogicMonitor REST API v3を使用すると、最新の機能と拡張機能をプログラム的に活用できます。LogicMonitorは、以前のAPIバージョンに新しい機能エンドポイントを追加しません。以前のバージョンのAPIを活用している場合は、 REST APIv2について or REST APIv1について.
LogicMonitorのREST APIの廃止アップデートの詳細については、以下を参照してください。 LogicMonitor REST API v1、v2、v3 の更新 コミュニティで。
LogicMonitor REST API v3 Swagger ドキュメントには、v3 API エンドポイントとエンドポイントに関連するモデルの完全なリストが含まれています。 各 API エンドポイントを展開して詳細を調べることができます。 これには、リクエストとレスポンスのパラメーターと、例と説明が含まれています。
- API 呼び出しを行う前に、 認証 あなた自身。
- 「?v=3」クエリ パラメータまたは「X-Version:3」ヘッダーを含めることによって、v3 リクエストを行うことができます。
- API 呼び出しの本文で渡されるプロパティでは、大文字と小文字が区別されます。
- クラウドデバイスを追加する場合、問題が発生する可能性があるため、NetScanを使用してクラウドデバイスを検出しないでください。代わりに、新しいオンボーディングプロセスに従ってください。詳細については、 LM クラウド モニタリングの概要, ローカルコレクターを使用したクラウドモニタリングの有効化, AWS モニタリングのセットアップ.
- オフセットは、データセット内の特定のレコードの位置を示します。 これがリストの開始点です。 たとえば、10 個の要素の配列があり、API リクエストでオフセットを 4 に指定すると、API レスポンスは 5 番目の要素以降の結果を返します。
- アラートを取得する場合、オフセット制限は 10000 アラートです。
- サイズは、応答で一度に返す要素の数を示します。 たとえば、size=60 を指定すると、応答は 60 件のバッチで結果を返します。LogicMonitor REST API v3 は、最大サイズ 1000 レコードをサポートします。 1000 を超える数値を指定した場合でも、応答は常に 1000 レコードを返します。 たとえば、アラートが 7000 件あり、offset=1000 および size=500 と設定したとします。 応答で、API は 1001 から 1500 までのアラートを返します。
- SDT エンドポイントの場合、選択した SDT のタイプに応じて、応答に追加のフィールドが含まれる場合があります。
- ウィジェット エンドポイントの場合、選択したウィジェット タイプに基づいて、リクエストとレスポンスに追加の属性が含まれます。 属性の詳細については、Swagger ドキュメントの最後にある、選択したウィジェット タイプに固有のモデルを参照してください。