[comment]: # aside: 1

[comment]: # ({b751c407-a17bb95b})
# Web 场景对象

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

[comment]: # ({/b751c407-a17bb95b})

[comment]: # ({24442f22-e60908bb})
### Web 场景

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

|属性|[类型](/manual/api/reference_commentary#data-types)|描述|
|--|--|------|
|httptestid|ID|Web 场景的 ID。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *只读*<br>- *更新操作*时*必填*|
|hostid|ID|该 Web 场景所属主机的 ID。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *常量*<br>- *创建操作*时*必填*|
|name|string|Web 场景的名称。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *创建操作*时*必填*|
|agent|string|Web 场景将使用的用户代理字符串。<br><br>默认值：Zabbix|
|authentication|integer|Web 场景将使用的认证方式。<br><br>可能的值：<br>0 - *(默认)* 无；<br>1 - 基本 HTTP 认证；<br>2 - NTLM 认证；<br>3 - Kerberos 认证；<br>4 - Digest 认证。|
|delay|string|Web 场景的执行间隔。<br><br>接受秒数或带后缀的时间单位（例如 30s、1m、2h、1d），也可以使用用户宏。<br><br>默认值：1m。|
|headers|array|执行请求时将发送的 [HTTP 标头](/manual/api/reference/httptest/object#http-field)。|
|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 场景在失败前尝试执行每个步骤的次数。<br><br>默认值：1。|
|ssl\_cert\_file|string|用于客户端认证的 SSL 证书文件名称（必须为 PEM 格式）。|
|ssl\_key\_file|string|用于客户端认证的 SSL 私钥文件名称（必须为 PEM 格式）。|
|ssl\_key\_password|string|SSL 私钥密码。|
|status|integer|Web 场景是否启用。<br><br>可能的值：<br>0 - *(默认)* 已启用；<br>1 - 已禁用。|
|templateid|ID|父模板 Web 场景的 ID。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *只读*|
|variables|array|Web 场景的[变量](/manual/api/reference/httptest/object#http-field)。|
|verify\_host|integer|是否验证连接所使用的主机名与主机证书中的主机名是否匹配。<br><br>可能的值：<br>0 - *(默认)* 跳过主机验证；<br>1 - 验证主机。|
|verify\_peer|integer|是否验证主机证书是否真实有效。<br><br>可能的值：<br>0 - *(默认)* 跳过对端验证；<br>1 - 验证对端。|
|uuid|string|全局唯一标识符，用于将导入的 Web 场景与已存在的 Web 场景关联。如果未提供，则自动生成。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- 如果 Web 场景属于模板，则*支持*|

[comment]: # ({/24442f22-e60908bb})

[comment]: # ({06fda153-eb20f47d})
### 场景步骤

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

|属性|[类型](/manual/api/reference_commentary#data-types)|描述|
|--|--|------|
|name|string|场景步骤的名称。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *必填*|
|no|integer|web 场景中该步骤的顺序号。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *必填*|
|url|string|要检查的 URL。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *必填*|
|follow\_redirects|integer|是否跟随 HTTP 重定向。<br><br>可能的值：<br>0 - 不跟随重定向；<br>1 - *(默认)* 跟随重定向。|
|headers|array|执行请求时将发送的 [HTTP 标头](/manual/api/reference/httptest/object#http-field)。场景步骤标头将覆盖为 web 场景指定的标头。|
|posts|string/array|HTTP POST 变量，可以是字符串（原始 POST 数据）或 [HTTP 字段](/manual/api/reference/httptest/object#http-field) 数组（表单字段数据）。|
|required|string|响应中必须存在的文本。|
|retrieve\_mode|integer|场景步骤必须获取的 HTTP 响应部分。<br><br>可能的值：<br>0 - *(默认)* 仅正文；<br>1 - 仅标头；<br>2 - 标头和正文。|
|status\_codes|string|所需 HTTP 状态码的范围，以逗号分隔。|
|timeout|string|请求超时时间，单位为秒。接受秒数、带后缀的时间单位或用户宏。<br><br>默认值：15s。最大值：1h。最小值：1s。|
|variables|array|场景步骤[变量](/manual/api/reference/httptest/object#http-field)。|
|query\_fields|array|查询字段 - 执行请求时将添加到 URL 的 [HTTP 字段](/manual/api/reference/httptest/object#http-field) 数组。|

[comment]: # ({/06fda153-eb20f47d})

[comment]: # ({75483b8b-d69e8b7b})
#### HTTP 字段

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

|属性|[类型](/manual/api/reference_commentary#data-types)|描述|
|--|--|------|
|name|string|标头/变量/POST 或 GET 字段的名称。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior):<br>- *必填*|
|value|string|标头/变量/POST 或 GET 字段的值。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior):<br>- *必填*|

[comment]: # ({/75483b8b-d69e8b7b})

[comment]: # ({d93e46b7-c7ab7fb0})
### Web 场景标签

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

|属性|[类型](/manual/api/reference_commentary#data-types)|描述|
|--|--|------|
|tag|string|Web 场景标签名称。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *必填*|
|value|string|Web 场景标签值。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *只读*。|
|object|integer|标签继承自的对象类型。<br><br>可能的值：<br>0 - 模板；<br>1 - 主机。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *只读*。|
|objectid|ID|标签继承自的对象 ID。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- *只读*。|

[comment]: # ({/d93e46b7-c7ab7fb0})