Web 场景对象

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

Web 场景

Web 场景对象具有以下属性。

Property Type Description
httptestid ID Web 场景的 ID。

Property behavior
- 只读
- 更新操作时必需
hostid ID Web 场景所属主机的 ID。

Property behavior
- 常量
- 创建操作时必需
name string Web 场景的名称。

Property behavior
- 创建操作时必需
agent string Web 场景使用的 User-Agent 字符串。

默认值:Zabbix
authentication integer Web 场景使用的身份验证方法。

可能的值:
0 - (默认)无;
1 - 基本 HTTP 身份验证;
2 - NTLM 身份验证;
3 - Kerberos 身份验证;
4 - 摘要身份验证。
delay string Web 场景的执行间隔。

接受秒数(例如 160300)、带有时间后缀的值(例如 30s1m2h1d),或用户宏。

默认值:1m。
headers array 执行请求时发送的 HTTP 标头
http_password string 用于基本 HTTP、NTLM、Kerberos 或摘要身份验证的密码。
http_proxy string Web 场景使用的 proxy,格式为 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。

Property behavior
- 只读
variables array Web 场景变量
verify_host integer 是否验证连接的主机名与主机证书中的名称匹配。

可能的值:
0 - (默认)跳过主机验证;
1 - 验证主机。
verify_peer integer 是否验证主机证书的真实性。

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

Property behavior
- 如果 Web 场景属于模板,则支持

场景步骤

场景步骤对象定义特定的 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 重定向。

可能的值:
0 - 不跟随重定向;
1 - (default) 跟随重定向。
headers array 执行请求时将发送的 HTTP 标头。场景步骤标头将覆盖为 Web 场景指定的标头。
posts string/array 以字符串(原始 POST 数据)或 HTTP 字段数组(表单字段数据)表示的 HTTP POST 变量。
required string 响应中必须存在的文本。
retrieve_mode integer 场景步骤必须获取的 HTTP 响应部分。

可能的值:
0 - (default) 仅正文;
1 - 仅标头;
2 - 标头和正文。
status_codes string 所需 HTTP 状态码的范围,以逗号分隔。
timeout string 请求超时时间,单位为秒。接受秒数(例如 160300)、带有时间后缀的值(例如 30s1m1h)或用户宏。

默认值: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 场景标签对象具有以下属性。

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

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