[comment]: # aside: 1

[comment]: # translation:outdated

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

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

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

[comment]: # ({6e8252e9-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 身份验证。|
|delay|string|Web 场景的执行间隔。<br><br>接受秒或带后缀的时间单位（例如 30 秒、1 分钟、2 小时、1 天）或用户宏。<br><br>默认值：1 分钟。|
|headers|array|执行请求时将发送的[HTTP 标头](/manual/api/reference/httptest/object#http-field)。|
|http\_password|string|用于基本 HTTP 或 NTLM 身份验证的密码。|
|http\_proxy|string|Web 场景将使用的代理，形式为 *http://\[username\[:password\]@\]proxy.example.com\[:port\]*。|
|http\_user|string|用于基本 HTTP 或 NTLM 身份验证的用户名。|
|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 场景链接到已经存在的场景。如果未指定，则自动生成。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior)：<br>- 如果 Web 场景属于模板，则 *支持*|

[comment]: # ({/6e8252e9-e60908bb})

[comment]: # ({550e6dd8-eb20f47d})
### 场景步骤

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

|属性|[类型](/manual/api/reference_commentary#data_types)|说明|
|--|--|------|
|name|string|场景步骤的名称。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior):<br>- *必填*|
|no|整数|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 变量作为字符串（原始帖子数据）或作为 [HTTP 字段](/manual/api/reference/httptest/object#http-field) 数组（表单字段数据）。|
|required|string|响应中必须存在的文本。|
|retrieve\_mode|整数|场景步骤必须检索的 HTTP 响应的一部分。<br><br>可能的值：<br>0 - *（默认）* 仅主体；<br>1 - 仅标头；<br>2 - 标头和主体。|
|status\_codes|字符串|所需 HTTP 状态代码的范围，以逗号分隔。|
|timeout|字符串|请求超时（秒）。接受秒、带后缀的时间单位或用户宏。<br><br>默认值：15 秒。最大值：1 小时。最小值：1 秒。|
|variables|数组|场景步骤 [变量](/manual/api/reference/httptest/object#http-field)。|
|query\_fields|数组|查询字段 - 执行请求时将添加到 URL 的 [HTTP 字段](/manual/api/reference/httptest/object#http-field) 数组。|

[comment]: # ({/550e6dd8-eb20f47d})

[comment]: # ({10a55bc3-d69e8b7b})
### HTTP 字段

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

|属性|[类型](/manual/api/reference_commentary#data_types)|说明|
|--|--|------|
|名称|字符串|标头/变量/POST 或 GET 字段的名称。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior):<br>- *必填*|
|值|字符串|标头/变量/POST 或 GET 字段的值。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior):<br>- *必填*|

[comment]: # ({/10a55bc3-d69e8b7b})

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

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

|属性|[类型](/manual/api/reference_commentary#data_types)|说明|
|--|--|------|
|tag|string|Web 场景标签名称。<br><br>[属性行为](/manual/api/reference_commentary#property-behavior):<br>- *必填*|
|值|string|Web 场景标签值。|

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