Table of Contents
Web scenarioオブジェクト
次のオブジェクトは、webcheckAPIに直接関連しています。
Webシナリオ
Webシナリオオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| httptestid | ID | WebシナリオのID。 プロパティの動作: - 読み取り専用 - 更新操作時に必須 |
| hostid | ID | Webシナリオが属するホストのID。 プロパティの動作: - 定数 - 作成操作時に必須 |
| name | string | Webシナリオの名前。 プロパティの動作: - 作成操作時に必須 |
| agent | string | Webシナリオで使用されるユーザーエージェント文字列。 デフォルト: Zabbix |
| authentication | integer | Webシナリオで使用される認証方式。 指定可能な値: 0 - (デフォルト) なし; 1 - 基本HTTP認証; 2 - NTLM認証。 |
| delay | string | Webシナリオの実行間隔。 秒またはサフィックス付きの時間単位（例: 30s, 1m, 2h, 1d）、またはユーザーマクロを受け付けます。 デフォルト: 1m。 |
| headers | array | リクエスト実行時に送信されるHTTPヘッダー。 |
| http_password | string | 基本HTTPまたはNTLM認証に使用されるパスワード。 |
| http_proxy | string | Webシナリオで使用されるプロキシ。http://[username[:password]@]proxy.example.com[:port]の形式で指定。 |
| http_user | string | 基本HTTPまたはNTLM認証に使用されるユーザー名。 |
| retries | integer | Webシナリオが各ステップを失敗するまでに実行を試みる回数。 デフォルト: 1。 |
| ssl_cert_file | string | クライアント認証に使用されるSSL証明書ファイル名（PEM形式である必要があります）。 |
| ssl_key_file | string | クライアント認証に使用されるSSL秘密鍵ファイル名（PEM形式である必要があります）。 |
| ssl_key_password | string | SSL秘密鍵のパスワード。 |
| status | integer | Webシナリオが有効かどうか。 指定可能な値: 0 - (デフォルト) 有効; 1 - 無効。 |
| templateid | ID | 親テンプレートWebシナリオのID。 プロパティの動作: - 読み取り専用 |
| variables | array | Webシナリオの変数。 |
| verify_host | integer | 接続先のホスト名がホストの証明書のものと一致するかどうかを検証するか。 指定可能な値: 0 - (デフォルト) ホスト検証をスキップ; 1 - ホストを検証。 |
| verify_peer | integer | ホストの証明書が正当かどうかを検証するか。 指定可能な値: 0 - (デフォルト) ピア検証をスキップ; 1 - ピアを検証。 |
| uuid | string | インポートされたWebシナリオを既存のものにリンクするために使用されるグローバル一意識別子。指定されていない場合は自動生成されます。 プロパティの動作: - Webシナリオがテンプレートに属する場合にサポート |
シナリオステップ
シナリオステップオブジェクトは、特定のWebシナリオチェックを定義します。以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| name | string | シナリオステップの名前。 プロパティの動作: - 必須 |
| no | integer | Webシナリオ内のステップのシーケンス番号。 プロパティの動作: - 必須 |
| url | string | チェックするURL。 プロパティの動作: - 必須 |
| follow_redirects | integer | HTTPリダイレクトを追跡するかどうか。 可能な値: 0 - リダイレクトを追跡しない; 1 - (デフォルト) リダイレクトを追跡する。 |
| headers | array | リクエスト実行時に送信されるHTTPヘッダー。シナリオステップのヘッダーは、Webシナリオで指定されたヘッダーを上書きします。 |
| posts | string/array | HTTP POST変数。文字列(生のPOSTデータ)またはHTTPフィールドの配列(フォームフィールドデータ)として指定します。 |
| required | string | レスポンス内に存在しなければならないテキスト。 |
| retrieve_mode | integer | シナリオステップが取得する必要があるHTTPレスポンスの部分。 可能な値: 0 - (デフォルト) ボディのみ; 1 - ヘッダーのみ; 2 - ヘッダーとボディ。 |
| status_codes | string | 必要なHTTPステータスコードの範囲。カンマ区切りで指定。 |
| timeout | string | リクエストのタイムアウト(秒)。秒数、単位付きの時間、またはユーザーマクロを指定可能。 デフォルト: 15s。最大: 1h。最小: 1s。 |
| variables | array | シナリオステップの変数。 |
| query_fields | array | クエリフィールド - リクエスト実行時にURLに追加されるHTTPフィールドの配列。 |
HTTPフィールド
HTTPフィールドオブジェクトは、Webシナリオの変数、HTTPヘッダー、POSTフィールドまたはクエリフィールドを指定するために使用される名前と値を定義します。 次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| name | string | ヘッダー/変数/POSTまたはGETフィールドの名前。 プロパティの動作: - 必須 |
| value | string | ヘッダー/変数/POSTまたはGETフィールドの値。 プロパティの動作: - 必須 |
Webシナリオタグ
Webシナリオタグオブジェクトには、以下のプロパティがあります。