> Web场景对象

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

Web场景

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

属性类型描述
httptestidstring(只读) Web场景的ID。
hostid
(必填)
stringWeb场景所属主机的ID。
name
(必填)
stringWeb场景的名称。
agentstringWeb场景将使用的用户代理字符串。

默认: Zabbix
authenticationintegerWeb场景将使用的身份认证方法。

可用值:
0 - (默认) none;
1 - 基本的HTTP身份认证;
2 - NTLM身份认证。
delaystringWeb场景的执行间隔。接受秒,带后缀的时间单位和用户宏。

默认: 1m。
headersarray of HTTP fields执行请求时将发送的HTTP请求头。
http_passwordstring用于基本的HTTP或NTLM身份认证的密码。
http_proxystringWeb场景将使用的代理,如下所示: http://[username[:password]@]proxy.example.com[:port]
http_userstring用于基本的HTTP或NTLM身份认证的用户名。
nextchecktimestamp(只读)下一个Web场景执行的时间。
retriesintegerWeb场景在失败之前尝试执行每个步骤的次数。

默认: 1。
ssl_cert_filestring用于客户端身份认证的SSL证书文件的名称(必须是PEM格式)。
ssl_key_filestring用于客户端身份认证的SSL私钥文件的名称(必须是PEM格式)。
ssl_key_passwordstringSSL私钥密码。
statusintegerWeb场景是否可用。

可用值:
0 - (默认) 可用;
1 - 不可用。
templateidstring(只读) 父模板Web场景的ID。
variablesarray of HTTP fieldsWeb场景变量。
verify_hostinteger是否验证SSL证书里指定的主机名与Web场景中使用的主机名匹配。

可能的值:
0 - (默认) 跳过主机验证;
1 - 验证主机。
verify_peerinteger是否验证Web服务器的SSL证书。

可用值:
0 - (默认) 跳过对等验证;
1 - 验证对等。
uuidstring(在现有的Web场景上只读)
全局唯一标识符,用于将导入的Web场景连接到现有场景。仅用于模板上的web场景。

Web场景标签

Web场景标签对象具有如下属性。

属性类型描述
tag
(必填)
stringWeb场景标签的名称。
valuestringWeb场景标签的值。

场景步骤

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

属性类型描述
httpstepidstring(只读) Web场景步骤ID。
name
(必填)
stringWeb场景的名称。
no
(必填)
integer一个Web场景步骤的序列号。
url
(必填)
string待检查的URL。
follow_redirectsinteger是否遵循HTTP重定向。

可用值:
0 - 不遵循重定向;
1 - (默认) 遵循重定向。
headersarray of HTTP fields执行请求时将发送的HTTP请求头。场景步骤请求头将被重写为Web场景指定的请求头。
httptestidstring(只读) 步骤所属Web场景的ID。
postsstring
array of HTTP fields
HTTP POST变量作为一个字符串(原始的post数据)或一个HTTP fields (表单字段数据)的数组。
requiredstring响应中必须出现的文本。
retrieve_modeinteger场景步骤必须获取的一部分HTTP响应。

可用值:
0 - (默认) 仅返回内容;
1 - 仅请求头;
2 - 请求头和内容。
status_codesstring用逗号隔开的所需HTTP状态码的范围。
timeoutstring请求超时时间(秒)。接受秒,带后缀的时间单位和用户宏。

默认: 15s。 最大值: 1h。 最小值: 1s。
variablesarray of HTTP fields场景步骤的变量。
query_fieldsarray of HTTP fields查询字段 - 执行请求时将被添加到URL中的HTTP fields数组。

HTTP字段

HTTP字段定义了名称和值,用于指定查询字段数据中的变量,HTTP请求头,POST表单字段数据。具有如下属性。

属性类型描述
name
(必填)
string请求头/变量/POST或GET字段的名称。
value
(必填)
string请求头/变量/POST或GET字段的值。