Table of Contents
Web场景 object
以下objects与webcheckAPI直接相关.
Web 场景
Web场景object具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| httptestid | ID | Web场景的ID。 属性行为: - 只读 - 进行update操作时必需 |
| hostid | ID | Web场景所属的主机的ID。 属性行为: - 常量 - 进行create操作时必需 |
| name | string | Web场景的名称。 属性行为: - 进行create操作时必需 |
| agent | string | Web场景将使用的用户agentstring。 默认值: Zabbix |
| authentication | integer | Web场景将使用的认证方法。 可能的值: 0 - (默认) 无; 1 - 基本HTTP认证; 2 - NTLM认证。 |
| delay | string | Web场景的执行间隔。 接受秒数或带后缀的时间单位(例如30s, 1m, 2h, 1d)，或用户宏。 默认值: 1m。 |
| headers | array | 执行请求时将发送的http字段。 |
| http_password | string | 用于基本HTTP或NTLM认证的密码。 |
| http_proxy | string | Web场景将使用的Proxy，格式为http://[用户名[:密码]@]proxy.example.com[:端口]。 |
| http_user | string | 用于基本HTTP或NTLM认证的用户名。 |
| retries | integer | Web场景在失败前尝试execute每个步骤的次数。 默认值: 1。 |
| ssl_cert_file | string | 用于客户端认证的SSL证书file的名称(必须为PEM格式)。 |
| ssl_key_file | string | 用于客户端认证的SSL私钥file的名称(必须为PEM格式)。 |
| ssl_key_password | string | SSL私钥密码。 |
| status | integer | Web场景是否启用。 可能的值: 0 - (默认) 启用; 1 - 禁用。 |
| templateid | ID | 父模板Web场景的ID。 属性行为: - 只读 |
| variables | array | Web场景http字段。 |
| verify_host | integer | 是否验证连接的主机名称与主机证书中的名称匹配。 可能的值: 0 - (默认) 跳过主机验证; 1 - 验证主机。 |
| verify_peer | integer | 是否验证主机证书的真实性。 可能的值: 0 - (默认) 跳过对等验证; 1 - 验证对等。 |
| uuid | string | 全局唯一标识符，用于将导入的Web场景链接到已存在的Web场景。如果未提供，则自动生成。 属性行为: - 如果Web场景属于模板则支持 |
场景步骤
场景步骤object定义了特定的Web场景检查。它具有以下属性。
| 属性 | 数据类型 | 描述 |
|---|---|---|
| name | string | 场景步骤的名称。 属性行为: - 必填 |
| no | integer | Web场景中步骤的序号。 属性行为: - 必填 |
| url | string | 要检查的URL。 属性行为: - 必填 |
| follow_redirects | integer | 是否跟随HTTP重定向。 可能的值: 0 - 不跟随重定向; 1 - (默认) 跟随重定向。 |
| headers | array | 执行请求时将发送的http字段。场景步骤头部将覆盖为Web场景指定的头部。 |
| posts | string/array | HTTP POST变量作为string(原始POST数据)或作为http字段的array(表单字段数据)。 |
| required | string | 响应中必须存在的文本。 |
| retrieve_mode | integer | HTTP响应中场景步骤必须检索的部分。 可能的值: 0 - (默认) 仅正文; 1 - 仅头部; 2 - 头部和正文。 |
| status_codes | string | 所需的HTTP状态码范围，用逗号分隔。 |
| timeout | string | 请求超时时间(秒)。接受秒数、带后缀的时间单位或用户宏。 默认: 15s。最大值: 1h。最小值: 1s。 |
| variables | array | 场景步骤http字段。 |
| query_fields | array | query字段 - 执行请求时将添加到URL的http字段的array。 |
HTTP字段
HTTP字段object用于定义指定Web场景变量、HTTP头部以及POST字段或query字段的名称和值。 它具有以下属性。
Web 场景标签
Web场景标签object具有以下属性.