Web 场景对象

以下对象与 webcheck API 直接相关。

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 - Digest 认证。
delay string Web 场景的执行间隔。

接受秒数或带后缀的时间单位（例如 30s、1m、2h、1d），也可以使用用户宏。

默认值：1m。
headers array 执行请求时将发送的 HTTP 标头。
http_password string 用于基本 HTTP、NTLM、Kerberos 或 Digest 认证的密码。
http_proxy string Web 场景将使用的 proxy，格式为 http://\[username\[:password\]@\]proxy.example.com\[:port]。
http_user string 用于基本 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 - (默认) 已启用；
1 - 已禁用。
templateid ID 父模板 Web 场景的 ID。

属性行为：
- 只读
variables array Web 场景的变量。
verify_host integer 是否验证连接所使用的主机名与主机证书中的主机名是否匹配。

可能的值：
0 - (默认) 跳过主机验证；
1 - 验证主机。
verify_peer integer 是否验证主机证书是否真实有效。

可能的值：
0 - (默认) 跳过对端验证；
1 - 验证对端。
uuid string 全局唯一标识符，用于将导入的 Web 场景与已存在的 Web 场景关联。如果未提供，则自动生成。

属性行为：
- 如果 Web 场景属于模板，则支持

场景步骤

场景步骤对象定义了一个特定的 web 场景检查。它具有以下属性。

Property Type Description
name string 场景步骤的名称。

属性行为:
- required
no integer web 场景中步骤的序号。

属性行为:
- required
url string 要检查的 URL。

属性行为:
- required
follow_redirects integer 是否跟随 HTTP 重定向。

Possible values:
0 - don't follow redirects;
1 - (default) follow redirects.
headers array 执行请求时将发送的 HTTP headers。场景步骤的 headers 将覆盖为 web 场景指定的 headers。
posts string/array HTTP POST 变量，格式为字符串（原始 post 数据）或 HTTP fields 数组（表单字段数据）。
required string 响应中必须存在的文本。
retrieve_mode integer 场景步骤必须检索的 HTTP 响应部分。

Possible values:
0 - (default) only body;
1 - only headers;
2 - headers and body.
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 字段或查询字段的名称和值。
它具有以下属性。

属性 类型 描述
name string 标头/变量/POST 或 GET 字段的名称。

属性行为:
- 必填
value string 标头/变量/POST 或 GET 字段的值。

属性行为:
- 必填

Web 场景标签

web 场景标签对象具有以下属性。

Property Type Description
tag string Web 场景标签名称。

属性行为:
- 必需
value string Web 场景标签值。