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認証;
3 - Kerberos認証;
4 - ダイジェスト認証。
delay string Webシナリオの実行間隔。

秒数（例: 1、60、300）、時間のサフィックス付きの値（例: 30s、1m、2h、1d）、またはユーザーマクロを指定できます。

デフォルト: 1m。
headers array リクエストの実行時に送信されるHTTPヘッダー。
http_password string 基本HTTP、NTLM、Kerberos、またはダイジェスト認証で使用するパスワード。
http_proxy string Webシナリオで使用するプロキシ。http://\[username\[:password\]@\]proxy.example.com\[:port] の形式で指定します。
http_user string 基本HTTP、NTLM、Kerberos、またはダイジェスト認証で使用するユーザー名。
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シナリオがテンプレートに属している場合にサポート

シナリオステップ

シナリオステップオブジェクトは、特定のWebシナリオチェックを定義します。 以下のプロパティがあります。

プロパティ タイプ 説明
name string シナリオステップの名前。

プロパティの動作:
- 必須
no integer Webシナリオ内のステップのシーケンス番号。

プロパティの動作:
- 必須
url string チェックするURL。

プロパティの動作:
- 必須
follow_redirects integer HTTPリダイレクトに従うかどうか。

指定可能な値:
0 - リダイレクトに従わない;
1 - (デフォルト) リダイレクトに従う。
headers array リクエストの実行時に送信されるHTTPヘッダー。シナリオステップのヘッダーは、Webシナリオに指定されたヘッダーを上書きします。
posts string/array 文字列（raw POSTデータ）またはHTTPフィールドの配列（フォームフィールドデータ）として指定するHTTP POST変数。
required string レスポンスに含まれている必要があるテキスト。
retrieve_mode integer シナリオステップが取得する必要があるHTTPレスポンスの部分。

指定可能な値:
0 - (デフォルト) 本文のみ;
1 - ヘッダーのみ;
2 - ヘッダーと本文。
status_codes string カンマで区切られた、必要なHTTPステータスコードの範囲。
timeout string リクエストのタイムアウト（秒）。秒数（例: 1、60、300）、時間のサフィックス付きの値（例: 30s、1m、1h）、またはユーザーマクロを指定できます。

デフォルト: 15s。最大: 1h。最小: 1s。
variables array シナリオステップの変数。
query_fields array クエリフィールド。リクエストの実行時にURLに追加されるHTTPフィールドの配列。

HTTPフィールド

HTTPフィールドオブジェクトは、Webシナリオの変数、HTTPヘッダー、POSTフィールドまたはクエリフィールドを指定するために使用される名前と値を定義します。
このオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
name string ヘッダー/変数/POSTまたはGETフィールドの名前。

プロパティの動作:
- 必須
value string ヘッダー/変数/POSTまたはGETフィールドの値。

プロパティの動作:
- 必須

Webシナリオタグ

Webシナリオタグオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
tag string Webシナリオタグ名。

プロパティの動作:
- 必須
value string Webシナリオタグ値。

プロパティの動作:
- 読み取り専用。
object integer タグの継承元オブジェクトのタイプ。

使用可能な値:
0 - テンプレート;
1 - ホスト.

プロパティの動作:
- 読み取り専用。
objectid ID タグの継承元オブジェクトのID。

プロパティの動作:
- 読み取り専用。