Documentation
Table of Contents
> Objeto de escenario web
Los siguientes objetos están directamente relacionados con la API webcheck.
Escenario web
El objeto de escenario web tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| httptestid | cadena | (lecturaobligatoria) ID del escenario web. |
| hostid (obligatorio) |
cadena | ID del host al que pertenece el escenario web. |
| nombre (obligatorio) |
cadena | Nombre del escenario web. |
| agent | string | Cadena del agente de usuario que será utilizada por el escenario web. Predeterminado: Zabbix |
| autenticación | número entero | Método de autenticación que utilizará el escenario web. Valores posibles: 0 - (predeterminado) ninguno; 1 - autenticación HTTP básica; 2 - Autenticación NTLM. |
| retraso | cadena | Intervalo de ejecución del escenario web. Acepta segundos, unidad de tiempo con sufijo y macro de usuario. Predeterminado: 1m. |
| encabezados | matriz de HTTP fields | encabezados HTTP que se enviarán al realizar una solicitud. |
| http_password | cadena | Contraseña utilizada para la autenticación básica HTTP o NTLM. |
| http_proxy | cadena | Proxy que será utilizado por el escenario web dado como http://[nombre de usuario[:contraseña]@]proxy.example.com[:puerto]. |
| http_user | cadena | Nombre de usuario utilizado para la autenticación básica HTTP o NTLM. |
| nextcheck | marca de tempo | (lecturaobligatoria) Hora de la próxima ejecución del escenario web. |
| retries | número entero | Número de veces que un escenario web intentará ejecutar cada paso antes de fallar. Valor predeterminado: 1. |
| ssl_cert_file | cadena | Nombre del archivo de certificado SSL utilizado para la autenticación del cliente (debe estar en formato PEM). |
| ssl_key_file | cadena | Nombre del archivo de clave privada SSL utilizado para la autenticación del cliente (debe estar en formato PEM). |
| ssl_key_password | cadena | Contraseña de clave privada SSL. |
| status | número | Si el escenario web está habilitado. Los valores posibles son: 0 - (predeterminado) habilitado; 1 - deshabilitado. |
| templateid | cadena | (lecturaobligatoria) ID del escenario web de la template principal. |
| variables | matriz de HTTP fields | Variables de escenario web. |
| verify_host | número de entero | Si se valida que el nombre de host para la conexión coincide con el del certificado del host. Los valores posibles son: 0 - (predeterminado) omitir la verificación del host;< br>1 - verificar host. |
| verify_peer | número entero | Si se valida que el certificado del host es auténtico. Los valores posibles son: 0 - (predeterminado) omitir la verificación de pares; 1 - verificar pares. |
| uuid | cadena | Identificador único global, utilizado para vincular escenarios web importados con los ya existentes. Se utiliza únicamente para escenarios web en templates. |
Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.
Etiqueta de escenario web
El objeto de etiqueta del escenario web tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| etiqueta (obligatorio) |
cadena | Nombre de etiqueta del escenario web. |
| valor | cadena | Valor de etiqueta de escenario web. |
Paso del escenario
El objeto de paso del escenario define una verificación de escenario web específica. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| httpstepid | cadena | (lecturaobligatoria) ID del paso del escenario. |
| nombre (obligatorio) |
cadena | Nombre del paso del escenario. |
| no (obligatorio) |
número entero | Número de secuencia del paso en un escenario web. |
| url (obligatorio) |
cadena | URL a comprobar. |
| follow_redirects | número entero | Si se deben seguir los redireccionamientos HTTP. Los valores posibles son: 0: no seguir los redireccionamientos; 1: (predeterminado) seguir los redireccionamientos. |
| encabezados | matriz de campos HTTP | encabezados HTTP que se enviarán al realizar una solicitud. Los encabezados de los pasos del escenario sobrescribirán los encabezados especificados para el escenario web. |
| httptestid | string | (readonly) ID del escenario web al que pertenece el paso. |
| publicaciones | cadena matriz de HTTP fields |
Variables HTTP POST como una cadena (datos de publicación sin procesar) o como una matriz de HTTP fields (datos del campo de formulario). |
| requerido | cadena | Texto que debe estar presente en la respuesta. |
| retrieve_mode | número entero | Parte de la respuesta HTTP que el paso del escenario debe recuperar. Los valores posibles son: 0 - (predeterminado) solo cuerpo; 1 - solo encabezados; 2 - encabezados y cuerpo. |
| status_codes | cadena | Rangos de códigos de estado HTTP requeridos separados por comas. |
| timeout | cadena | Tiempo de espera de solicitud en segundos. Acepta segundos, unidad de tiempo con sufijo y macro de usuario. Predeterminado: 15 s. Máximo: 1h. Mínimo: 1s. |
| variables | matriz de HTTP fields | Variables de paso del escenario. |
| query_fields | matriz de HTTP fields | Campos de consulta - matriz de HTTP fields que se agregará a la URL al realizar una solicitud |
Campo HTTP
El objeto de campo HTTP define el nombre y el valor que se utiliza para especificar las variables del escenario web, los encabezados HTTP y los campos POST o de consulta. Tiene las siguientes propiedades.
| Propiedad | Type | Descripción |
|---|---|---|
| name (obligatorio) |
cadena | Nombre del encabezado / variable / campo de POST o GET. |