Web scenarioオブジェクト
次のオブジェクトは、webcheckAPIに直接関連しています。
Webシナリオ
Webシナリオオブジェクトには、以下のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| httptestid | ID | WebシナリオのID。 Property behavior: - read-only - 更新操作で required |
| hostid | ID | このWebシナリオが属するホストのID。 Property behavior: - constant - 作成操作で required |
| name | string | Webシナリオの名前。 Property behavior: - 作成操作で required |
| agent | string | Webシナリオで使用されるユーザーエージェント文字列。 デフォルト: Zabbix |
| authentication | integer | Webシナリオで使用される認証方式。 指定可能な値: 0 - (default) なし; 1 - Basic HTTP認証; 2 - NTLM認証; 3 - Kerberos認証; 4 - Digest認証。 |
| delay | string | Webシナリオの実行間隔。 秒、または接尾辞付きの時間単位（例: 30s, 1m, 2h, 1d）、あるいはユーザーマクロを指定できます。 デフォルト: 1m。 |
| headers | array | リクエスト実行時に送信されるHTTPヘッダー。 |
| http_password | string | Basic HTTP、NTLM、Kerberos、またはDigest認証で使用されるパスワード。 |
| http_proxy | string | http://\[username\[:password\]@\]proxy.example.com\[:port] の形式で指定する、Webシナリオで使用されるプロキシ。 |
| http_user | string | Basic HTTP、NTLM、Kerberos、またはDigest認証で使用されるユーザー名。 |
| 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 - (default) 有効; 1 - 無効。 |
| templateid | ID | 親テンプレートのWebシナリオID。 Property behavior: - read-only |
| variables | array | Webシナリオの変数。 |
| verify_host | integer | 接続先のホスト名が、そのホストの証明書内のホスト名と一致することを検証するかどうか。 指定可能な値: 0 - (default) ホスト検証をスキップ; 1 - ホストを検証。 |
| verify_peer | integer | ホストの証明書が正当であることを検証するかどうか。 指定可能な値: 0 - (default) ピア検証をスキップ; 1 - ピアを検証。 |
| uuid | string | インポートしたWebシナリオを既存のものにリンクするために使用されるグローバル一意識別子。指定しない場合は自動生成されます。 Property behavior: - Webシナリオがテンプレートに属している場合に supported |
シナリオステップ
シナリオステップオブジェクトは、特定のWebシナリオチェックを定義します。次のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| name | string | シナリオステップの名前。 Property behavior: - required |
| no | integer | Webシナリオ内でのステップのシーケンス番号。 Property behavior: - required |
| url | string | チェックするURL。 Property behavior: - required |
| follow_redirects | integer | HTTPリダイレクトに従うかどうか。 Possible values: 0 - リダイレクトに従わない; 1 - (default) リダイレクトに従う。 |
| headers | array | リクエスト実行時に送信されるHTTPヘッダー。シナリオステップのヘッダーは、Webシナリオで指定されたヘッダーを上書きします。 |
| posts | string/array | HTTP POST変数を文字列（raw post data）として、またはHTTP fieldsの配列（フォームフィールドデータ）として指定します。 |
| required | string | レスポンスに含まれている必要があるテキスト。 |
| retrieve_mode | integer | シナリオステップが取得する必要があるHTTPレスポンスの一部。 Possible values: 0 - (default) 本文のみ; 1 - ヘッダーのみ; 2 - ヘッダーと本文。 |
| status_codes | string | 必要なHTTPステータスコードの範囲をカンマ区切りで指定します。 |
| timeout | string | 秒単位のリクエストタイムアウト。秒、接尾辞付きの時間単位、またはユーザーマクロを指定できます。 Default: 15s. Maximum: 1h. Minimum: 1s. |
| variables | array | シナリオステップのvariables。 |
| query_fields | array | クエリフィールド - リクエスト実行時にURLへ追加されるHTTP fieldsの配列。 |
HTTPフィールド
HTTPフィールドオブジェクトは、Webシナリオの変数、HTTPヘッダー、POSTフィールドまたはクエリフィールドを指定するために使用される名前と値を定義します。
このオブジェクトには、以下のプロパティがあります。
| プロパティ | Type | 説明 |
|---|---|---|
| name | string | ヘッダー/変数/POSTまたはGETフィールドの名前。 プロパティの動作: - 必須 |
| value | string | ヘッダー/変数/POSTまたはGETフィールドの値。 プロパティの動作: - 必須 |
Webシナリオタグ
Webシナリオタグオブジェクトには、次のプロパティがあります。
| Property | Type | Description |
|---|---|---|
| tag | string | Webシナリオタグ名。 Property behavior: - required |
| value | string | Webシナリオタグの値。 |