> Web 场景 object

以下objects与webcheckAPI直接相关。

Web 场景

Web场景object具有以下属性。

属性 数据类型 描述
httptestid string (只读) Web场景的ID。
hostid
(required)
string Web场景所属的主机的ID。
name
(required)
string Web场景的名称。
agent string Web场景将使用的用户agentstring。

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

可能的值:
0 - (默认) 无;
1 - 基本HTTP认证;
2 - NTLM认证。
delay string Web场景的执行间隔。接受秒数、带后缀的时间单位和用户宏。

默认值:1m。
headers array of HTTP fields 执行请求时将发送的HTTP头。
http_password string 用于基本HTTP或NTLM认证的密码。
http_proxy string Web场景将使用的Proxy,格式为http://[用户名[:密码]@]proxy.example.com[:端口]
http_user string 用于基本HTTP或NTLM认证的用户名。
nextcheck timestamp (只读) 下一次Web场景执行的时间。
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 string (只读) 父模板Web场景的ID。
variables array of HTTP fields Web场景变量。
verify_host integer 是否验证连接的主机名称与主机证书中的名称匹配。

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

可能的值:
0 - (默认) 跳过对等验证;
1 - 验证对等。
uuid string 全局唯一标识符,用于将导入的Web场景链接到已存在的Web场景。仅用于模板上的Web场景。

请注意,某些方法(更新、删除)所需/可选参数的组合有所不同。

Web 场景标签

Web场景标签object具有以下属性。

属性 数据类型 描述
tag
(required)
string Web场景标签名称。
value string Web场景标签值。

场景步骤

场景步骤object定义了特定的Web场景检查,具有以下属性:

属性 数据类型 描述
httpstepid string (只读) 场景步骤的ID。
name
(required)
string 场景步骤的名称。
no
(required)
integer Web场景中步骤的序号。
url
(required)
string 待检查的URL。
follow_redirects integer 是否跟随HTTP重定向。

可能的值为:
0 - 不跟随重定向;
1 - (默认) 跟随重定向。
headers array of HTTP fields 执行请求时将发送的HTTP头部。场景步骤头部将覆盖为Web场景指定的头部。
httptestid string (只读) 步骤所属的Web场景的ID。
posts string
array of HTTP fields
HTTP POST变量,可以是string(原始POST数据)或HTTP字段的array(表单字段数据)。
required string 响应中必须包含的文本。
retrieve_mode integer 场景步骤必须检索的HTTP响应部分。

可能的值为:
0 - (默认) 仅正文;
1 - 仅头部;
2 - 头部和正文。
status_codes string 以逗号分隔的所需HTTP状态码范围。
timeout string 请求超时时间(秒)。接受秒数、带后缀的时间单位及用户宏。

默认值:15秒。最大值:1小时。最小值:1秒。
variables array of HTTP fields 场景步骤变量。
query_fields array of HTTP fields query字段 - 执行请求时将添加到URL的HTTP字段的array。

HTTP 字段

HTTP字段object用于定义名称和值,用于指定query字段数据的变量、HTTP头部、POST表单数据。它具有以下属性。

属性 数据类型 描述
name
(required)
string 头部/变量/POST或GET字段的名称。
value
(required)
string 头部/变量/POST或GET字段的值。