 |
This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved. |
1. はじめに
Checkmk は、web インターフェイスで可能なほとんどの操作を実行できる REST API をはじめ、さまざまなインターフェイスを多数提供しています。 また、チェックプラグイン、HW/SW インベントリ、エージェントベーカリーなどのAPI もご用意しています。 これらのインターフェイスについては、このユーザーガイド、web サイト、および Checkmk 自体に、記事、参考資料、その他のリソースが掲載されています。
この記事では、すべてのインターフェースとリソースの概要、および一般的な取り扱いに関するヒントをご紹介します。 この記事のリンクの多くは、3 つの異なるアプローチや質問に対応するため、重複しています。
Checkmk はどのような API を提供していますか？
ユーザーガイドには、API に関連する記事がどこにありますか？
Checkmk には API に関連するどのようなリソースがありますか？
最も重要なインターフェイスは、間違いなくCheckmk REST API です。これは、プログラミングの観点から、web インターフェイスでも実行できるほぼすべての操作に使用できます。
 |
対話型の REST API GUI では、REST API を迅速かつ実践的に紹介しています。 ここでは、あらかじめ定義されたクエリを送信し、必要に応じて変更することができます。 GUI は、Checkmk 内のHelp > Developer resources > REST API interactive GUI からアクセスできます。 |
2 つ目の主要なインターフェースは、独自の拡張機能を開発するためのプラグイン APIです。 ご経験に応じて、Checkmk 自体にある入門記事またはリファレンスから始められます。Help > Developer resource > Plug-in API references
以下の表には、これらの API だけでなく、HW/SW インベントリ、チェックプラグイン開発用のサブインターフェース（明示的な Graphing API など）、およびローカルチェックの出力フォーマット、本格的なプラグインの前身であるシンプルなスクリプトベースの準インターフェースなど、あまり馴染みのないインターフェースも記載されています。
2. Checkmk の API
| API | ユーザーガイド | Web | 説明 |
|---|---|---|---|
REST API |
機能的には web インターフェイスのサブセットです。 |
||
チェック API |
チェックプラグインのコーディング。 |
||
ベーカリーAPI |
Checkmk では： |
エージェントベーカリーにチェックプラグインを含めます。 |
|
サーバーサイドコール API |
Checkmk で: |
アクティブチェックおよびスペシャルエージェントを開発します。 |
|
グラフ API |
エージェントベースのチェックプラグインの記事でメトリックの表示をカスタマイズします。 |
Checkmk で： |
メトリック、グラフ、パーフオメーターを含めます。 |
ルールセット API |
エージェントベースのチェックプラグインの記事でチェックパラメータのルールセット |
Checkmk で： |
独自のルールセットを開発してください。 |
DCD API |
未定 |
Checkmk で： |
動的構成デーモン（DCD）によるダイナミックホストマネージメント用のカスタム接続。 |
HW/SW API |
未指定 |
インベントリデータを照会するための Web API。 |
|
ライブステータス |
未指定 |
ライブステータスクエリ言語 (LQL) によるステータスデータの直接取得。 |
|
イベントコンソールインターフェース |
イベントコンソールのステータスインターフェイス |
未定義 |
Unix ソケットによる内部ステータスへのアクセスおよびコマンドの実行。 |
ローカルチェック |
未定義 |
独自の スクリプトベースのチェック用「ミニインターフェース」。 |
3. ユーザーガイドの記事
| API エリア | ユーザーガイド | 説明 |
|---|---|---|
自動化 |
REST API の説明、ドキュメント、および使用方法。 |
|
ホストおよびサービス情報に関するデータインターフェースの概要です。 |
||
すべてのテーブル、ヘッダー、フィルター、およびオペレーター。 |
||
外部アクセス用のインベントリ独自の web API の説明。 |
||
イベントコンソールのステータスインターフェイス |
イベントコンソールからデータを読み取り、Unix ソケットおよびライブステータスプロトコルのサブセットを介してコマンドを送信することができます。 |
|
プログラミング |
拡張機能のすべての可能性と詳細情報へのリンクを記載した概要記事です。 |
|
チェックプラグインの開発方法の詳細な説明。 |
||
SNMP データ用のチェックプラグインの開発について詳しく説明します。 |
4. Checkmk のリソース
| Checkmk での | 説明 |
|---|---|
Help > Developer resources > Plug-in API references |
Check プラグインの開発に関連するすべての API の Sphinx ベースのリファレンス。 |
Help > Developer resources > REST API documentation |
Check に関連するすべてのクエリに関する ReDoc/OpenAPI ベースのリファレンス。Requests (Python)、Urllib (Python)、httpie、curl のコード例も含まれます。 |
Help > Developer resources > REST API interactive GUI |
すべての API エンドポイントをテストするための対話型の web インターフェイス。ページ上で直接フィードバックもできます。 |
Help > Developer resources > Plug-in API references > Agent based ("Check API") |
セクション「Version 2 > New in this version 」には、古いプラグインを現在の API バージョンに移行するための重要な情報が記載されています。 |
5. web 上のリソース
| リソース | 説明 |
|---|---|
スケジュールダウンタイムの設定など、REST API の使用例を実例で説明するビデオチュートリアル（英語）。 |
|
具体的な AND リンククエリなど、Checkmk ナレッジベースに掲載されている Curl の例。 |
|
Checkmk プラグインストアでは、ソースコードを含む API の実用的な実装例を多数ご覧いただけます。 |