On this page
Web场景 object
以下 objects 直接与 webcheck API 相关。
Web 场景
web 场景对象具有以下属性。
| Property | Type | Description |
|---|---|---|
| httptestid | ID | web 场景的 ID。 属性行为: - 只读 - 在更新操作中为 必需 |
| hostid | ID | web 场景所属主机的 ID。 属性行为: - 常量 - 在创建操作中为 必需 |
| name | string | web 场景的名称。 属性行为: - 在创建操作中为 必需 |
| agent | string | web 场景将使用的用户代理字符串。 默认值: Zabbix |
| authentication | integer | web 场景将使用的认证方法。 可能的值: 0 - (默认) 无； 1 - 基本 HTTP 认证； 2 - NTLM 认证； 3 - Kerberos 认证； 4 - Digest 认证。 |
| delay | string | web 场景的执行间隔。 接受秒数或带后缀的时间单位（例如，30s、1m、2h、1d），也可以是用户宏。 默认值: 1m。 |
| headers | array | 执行请求时将发送的 HTTP 头。 |
| http_password | string | 用于基本 HTTP、NTLM、Kerberos 或 Digest 认证的密码。 |
| http_proxy | string | web 场景将使用的 proxy，格式为 http://\[username\[:password\]@\]proxy.example.com\[:port]。 |
| http_user | string | 用于基本 HTTP、NTLM、Kerberos 或 Digest 认证的用户名。 |
| 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 | ID | 父模板 web 场景的 ID。 属性行为: - 只读 |
| variables | array | web 场景 变量。 |
| verify_host | integer | 是否验证连接的主机名与主机证书中的名称一致。 可能的值: 0 - (默认) 跳过主机验证； 1 - 验证主机。 |
| verify_peer | integer | 是否验证主机证书的真实性。 可能的值: 0 - (默认) 跳过对等验证； 1 - 验证对等方。 |
| uuid | string | 全局唯一标识符，用于将导入的 web 场景链接到已存在的场景。如果未提供，则自动生成。 属性行为: - 如果 web 场景属于模板，则 支持 |
场景步骤
场景步骤对象定义了一个特定的 web 场景检查。它具有以下属性。
| Property | Type | Description |
|---|---|---|
| name | string | 场景步骤的名称。 属性行为: - required |
| no | integer | web 场景中步骤的序号。 属性行为: - required |
| url | string | 要检查的 URL。 属性行为: - required |
| follow_redirects | integer | 是否跟随 HTTP 重定向。 可能的值： 0 - 不跟随重定向； 1 - (默认) 跟随重定向。 |
| headers | array | 执行请求时将发送的 HTTP 头。场景步骤的头会覆盖为 web 场景指定的头。 |
| posts | string/array | HTTP POST 变量，可以是字符串（原始 POST 数据）或 HTTP 字段 数组（表单字段数据）。 |
| required | string | 响应中必须存在的文本。 |
| retrieve_mode | integer | 场景步骤必须获取的 HTTP 响应部分。 可能的值： 0 - (默认) 仅正文； 1 - 仅头； 2 - 头和正文。 |
| status_codes | string | 所需 HTTP 状态码的范围，以逗号分隔。 |
| timeout | string | 请求超时时间，单位为秒。可接受秒数、带后缀的时间单位或用户宏。 默认值：15s。最大值：1h。最小值：1s。 |
| variables | array | 场景步骤 变量。 |
| query_fields | array | 查询字段 - 在执行请求时将添加到 URL 的 HTTP 字段 数组。 |
HTTP 字段
HTTP 字段对象定义用于指定 web 场景变量、HTTP 头以及 POST 字段或查询字段的名称和值。 它具有以下属性。
| Property | Type | Description |
|---|---|---|
| name | string | 头/变量/POST 或 GET 字段的名称。 Property behavior: - required |
| value | string | 头/变量/POST 或 GET 字段的值。 Property behavior: - required |
Web 场景标签
web 场景标签对象具有以下属性。