Web 场景对象

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

Web 场景

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

属性类型描述
httptestidIDWeb 场景的 ID。

属性行为:
- 只读
- 更新操作所需
hostidIDWeb 场景所属主机的 ID。

属性行为:
- 常量
- 创建操作所需
namestringWeb 场景的名称。

属性行为
- 创建操作所需
agentstringWeb 场景将使用的用户代理字符串。

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

可能的值:
0 - (默认值) 无;
1 - 基本 HTTP 身份验证;
2 - NTLM 身份验证。
delaystringWeb 场景的执行间隔。

接受秒或带后缀的时间单位(例如 30 秒、1 分钟、2 小时、1 天)或用户宏。

默认值:1 分钟。
headersarray执行请求时将发送的HTTP 标头
http_passwordstring用于基本 HTTP 或 NTLM 身份验证的密码。
http_proxystringWeb 场景将使用的代理,形式为 http://[username[:password]@]proxy.example.com[:port]
http_userstring用于基本 HTTP 或 NTLM 身份验证的用户名。
retriesintegerWeb 场景在失败前尝试执行每个步骤的次数。

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

可能的值:
0 - (默认) 已启用;
1 - 已禁用。
templateidID父模板 Web 方案的 ID。

属性行为
- 只读
variablesarrayWeb 方案 变量
verify_hostinteger是否验证连接的主机名是否与主机证书中的主机名匹配。

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

可能的值:
0 - (默认)跳过对等验证;
1 - 验证对等。
uuidstring全局唯一标识符,用于将导入的 Web 场景链接到已经存在的场景。如果未指定,则自动生成。

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

Web 场景标签

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

属性类型说明
tagstringWeb 场景标签名称。

属性行为:
- 必填
stringWeb 场景标签值。

场景步骤

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

属性类型说明
namestring场景步骤的名称。

属性行为:
- 必填
no整数Web 场景中步骤的序列号。

属性行为:
- 必填
urlstring要检查的 URL。

属性行为:
- 必填
follow_redirectsinteger是否遵循 HTTP 重定向。

可能的值:
0 - 不遵循重定向;
1 - (默认) 遵循重定向。
headersarray执行请求时将发送的HTTP 标头。场景步骤标头将覆盖为 Web 场景指定的标头。
postsstring/arrayHTTP POST 变量作为字符串(原始帖子数据)或作为 HTTP 字段 数组(表单字段数据)。
requiredstring响应中必须存在的文本。
retrieve_mode整数场景步骤必须检索的 HTTP 响应的一部分。

可能的值:
0 - (默认) 仅主体;
1 - 仅标头;
2 - 标头和主体。
status_codes字符串所需 HTTP 状态代码的范围,以逗号分隔。
timeout字符串请求超时(秒)。接受秒、带后缀的时间单位或用户宏。

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

HTTP 字段

HTTP 字段对象定义用于指定 Web 场景变量、HTTP 标头和 POST 字段或查询字段的名称和值。 它具有以下属性。

属性类型说明
名称字符串标头/变量/POST 或 GET 字段的名称。

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

属性行为:
- 必填