メソッドリファレンス

このセクションでは、Zabbix APIが提供する機能の概要を説明し、利用可能なクラスとメソッドの使い方を説明します。

監視

Zabbix APIでは、監視中に収集した履歴やその他のデータにアクセスすることができます。

高可用性(HA)クラスタ

サーバノードとそのステータスの一覧を取得します。

High availability cluster API

ヒストリ

Zabbix監視プロセスによって収集された過去の値を取得し、表示やさらなる処理を行うことができます。

History API

トレンド

Zabbixサーバーで計算されたトレンドの値を取得し、表示やさらなる処理を行うことができます。

Trend API

イベント

トリガー、ネットワークディスカバリ、その他のZabbixシステムから生成されたイベントを取得し、より柔軟な状況管理やサードパーティツールの統合を行うことができます。

Event API

障害

指定されたパラメータに従って、障害を取得します。

Problem API

サービス監視

監視するITインフラ/ビジネスサービスデータの階層表現を作成します。

Service API

サービスレベルアグリーメント(SLA)

サービスレベル目標（SLO）を定義し、サービスのパフォーマンスに関する詳細なサービスレベル指標（SLI）情報を取得します。

SLA API

タスク

Zabbixサーバーのタスクマネージャと連動し、タスクの作成とレスポンスの取得を行います。

Task API

設定

Zabbix APIでは、監視システムの設定を管理することができます。

ホストとホストグループ

ホストグループとホスト、およびホストインタフェース、ホストマクロ、メンテナンス期間など、ホストに関連するすべてのものを管理します。

Host API | Host group API | Host interface API | User macro API | Value map API | Maintenance API

アイテム

監視するアイテムを定義します

Item API

トリガー

システムの問題を通知するトリガーを構成します。トリガーの依存関係を管理します。

Trigger API

グラフ

収集したデータを見やすくするために、グラフを編集したり、グラフの item を分けたりすることができます。

Graph API | Graph item API

テンプレート

テンプレートを管理し、ホストや他のテンプレートとリンクさせることができます。

Template API | Value map API

エクスポートとインポート

設定のバックアップ、マイグレーション、大規模な設定更新のためにZabbixの設定データをエクスポート、インポートすることができます。

Configuration API

ローレベルディスカバリ

動的なエンティティを監視するために、ローレベルディスカバリルール、item、trigger、グラフのプロトタイプを設定します。

LLD rule API | Item prototype API | Trigger prototype API | Graph prototype API | Host prototype API

イベント相関

カスタムイベントの相関ルールを作成します。

Correlation API

アクションとアラート

特定のイベントをユーザーに通知したり、リモートコマンドを自動的に実行するためのアクションと操作を定義します。生成されたアラートとその受信者に関する情報にアクセスできます。

Action API | Alert API

サービス

サービスレベルのモニタリングのためにサービスを管理し、あらゆるサービスの詳細なSLA情報を取得することができます。

Service API

ダッシュボード

ダッシュボードを管理し、それに基づいてスケジュールされたレポートを作成します。

Dashboard API | Template dashboard API | Report API

マップ

マップを設定して、IT インフラストラクチャの詳細な動的表示を作成します。

Map API

Web監視

Webアプリケーションやサービスを監視するための Webシナリオを設定します。

Web scenario API

ネットワークディスカバリ

ネットワークレベルの検出ルールを管理し、新しいホストを自動的に検出して監視します。検出されたサービスとホストに関する情報に完全にアクセスできます。

Discovery rule API | Discovery check API | Discovered host API | Discovered service API

管理画面

Zabbix APIを使用すると、監視システムの管理設定を変更することができます。

ユーザー

Zabbixにアクセスするユーザを追加し、ユーザグループに割り当て、権限を付与します。ユーザーの権限を細かく管理するための役割を作成します。各ユーザが行った設定変更を追跡します。メディアタイプとユーザーがアラートを受信する複数の方法を設定することができます。

User API | User group API | User role API | Media type API | Audit log API

一般

特定のグローバル設定オプションを変更します。

Autoregistration API | Icon map API | Image API | User macro API | Settings API | Housekeeping API

正規表現

グローバルな正規表現を管理します。

Regular expression API

プロキシ

分散監視設定で使用されるZabbixプロキシを管理します。

Proxy API

認証

認証の設定オプションを変更します。

Authentication API

APIトークン

認可トークンを管理します。

Token API

スクリプト

日々の作業を支援するスクリプトを設定・実行します。

Script API

API情報

Zabbix APIのバージョンを取得し、アプリケーションでバージョン固有の機能を使用できるようにします。

API info API