Documentation
Table of Contents
Web场景 object
以下 objects 直接与 webcheck API 相关。
Web 场景
Web场景 object 具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| httptestid | ID | 网络场景的 ID。 属性行为: - 只读 - 必需的 用于 update 操作 |
| hostid | ID | 所属Web场景的主机 ID。 属性行为: - constant - required for create 操作 |
| name | string | Web场景的名称。 属性行为: - 必填 参数，用于 create 操作 |
| agent | string | 将被网页场景使用的用户 agent string。 默认值：Zabbix |
| authentication | integer | 网络场景将使用的认证方法。 可能的值： 0 - (默认) 无； 1 - 基本身份验证； 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 数据）或 array 类型的 http字段（表单字段数据）。 |
| 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 具有以下属性。