以下对象都是与webcheck
直接相关的API。
Web场景对象具有以下属性。
属性 | 类型 | 描述 |
---|---|---|
httptestid | string | (readonly) Web场景的ID。 |
hostid (required) |
string | Web场景所属主机的ID。 |
name (required) |
string | Web场景的名称。 |
agent | string | Web场景将使用的User agent字符串。 默认值:Zabbix |
authentication | integer | Web场景将使用的认证方法。 可能的值: 0 - (default) 无; 1 - 基本HTTP认证; 2 - NTLM认证。 |
delay | string | Web场景的执行间隔。接受秒数,时间单位后缀和用户宏。 默认值:1m。 |
headers | array 参考 HTTP字段 | 执行请求时将发送的HTTP头部。 |
http_password | string | 用于基本HTTP或NTLM认证的密码。 |
http_proxy | string | Web场景使用的代理,格式为http://[username[:password]@]proxy.example.com[:port]。 |
http_user | string | 用于基本HTTP或NTLM认证的用户名。 |
nextcheck | timestamp | (readonly) 下次Web场景执行的时间。 |
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 - (default) 启用; 1 - 禁用。 |
templateid | string | (readonly) 父模板Web场景的ID。 |
variables | array 参考 HTTP字段 | Web场景变量。 |
verify_host | integer | 是否验证连接的主机名是否与主机证书中的名称匹配。 可能的值是: 0 - (default) 跳过主机验证; 1 - 验证主机。 |
verify_peer | integer | 是否验证主机的证书是否真实。 可能的值是: 0 - (default) 跳过对等方验证; 1 - 验证对等方。 |
uuid | string | 全局唯一标识符,用于将导入的Web场景链接到已存在的Web场景。仅用于模板上的Web场景。 |
请注意,对于一些方法(更新,删除),所需/可选参数的组合是不同的。
Web场景标签对象具有如下属性。
属性 | 类型 | 描述 |
---|---|---|
tag (必填) |
string | Web场景标签的名称。 |
value | string | Web场景标签的值。 |
场景步骤对象定义了一个特定的Web场景检查。具有如下属性。
属性 | 类型 | 描述 |
---|---|---|
httpstepid | string | (只读) Web场景步骤ID。 |
name (必填) |
string | Web场景的名称。 |
no (必填) |
integer | 一个Web场景步骤的序列号。 |
url (必填) |
string | 待检查的URL。 |
follow_redirects | integer | 是否遵循HTTP重定向。 可用值: 0 - 不遵循重定向; 1 - (默认) 遵循重定向。 |
headers | array of HTTP fields | 执行请求时将发送的HTTP请求头。场景步骤请求头将被重写为Web场景指定的请求头。 |
httptestid | string | (只读) 步骤所属Web场景的ID。 |
posts | string array of HTTP fields |
HTTP POST变量作为一个字符串(原始的post数据)或一个HTTP fields (表单字段数据)的数组。 |
required | string | 响应中必须出现的文本。 |
retrieve_mode | integer | 场景步骤必须获取的一部分HTTP响应。 可用值: 0 - (默认) 仅返回内容; 1 - 仅请求头; 2 - 请求头和内容。 |
status_codes | string | 用逗号隔开的所需HTTP状态码的范围。 |
timeout | string | 请求超时时间(秒)。接受秒,带后缀的时间单位和用户宏。 默认: 15s。 最大值: 1h。 最小值: 1s。 |
variables | array of HTTP fields | 场景步骤的变量。 |
query_fields | array of HTTP fields | 查询字段 - 执行请求时将被添加到URL中的HTTP fields数组。 |
HTTP字段定义了名称和值,用于指定查询字段数据中的变量,HTTP请求头,POST表单字段数据。具有如下属性。
属性 | 类型 | 描述 |
---|---|---|
name (必填) |
string | 请求头/变量/POST或GET字段的名称。 |
value (必填) |
string | 请求头/变量/POST或GET字段的值。 |