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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| 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: Áú»¢¶Ä²© |
| ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô | ²Ô¨²³¾±ð°ù´Ç entero | M¨¦todo de ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô que utilizar¨¢ el escenario web. Valores posibles: 0 - (predeterminado) ninguno; 1 - ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô HTTP b¨¢sica; 2 - ´¡³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô 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 ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô 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 ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô b¨¢sica HTTP o NTLM. |
| nextcheck | marca de tempo | (lecturaobligatoria) Hora de la pr¨®xima ejecuci¨®n del escenario web. |
| retries | ²Ô¨²³¾±ð°ù´Ç 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 ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô del cliente (debe estar en formato PEM). |
| ssl_key_file | cadena | Nombre del archivo de clave privada SSL utilizado para la ²¹³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨®²Ô del cliente (debe estar en formato PEM). |
| ssl_key_password | cadena | Contrase?a de clave privada SSL. |
| status | ²Ô¨²³¾±ð°ù´Ç | 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 | ²Ô¨²³¾±ð°ù´Ç 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 | ²Ô¨²³¾±ð°ù´Ç 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| httpstepid | cadena | (lecturaobligatoria) ID del paso del escenario. |
| nombre (obligatorio) |
cadena | Nombre del paso del escenario. |
| no (obligatorio) |
²Ô¨²³¾±ð°ù´Ç entero | N¨²mero de secuencia del paso en un escenario web. |
| url (obligatorio) |
cadena | URL a comprobar. |
| follow_redirects | ²Ô¨²³¾±ð°ù´Ç 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 | ²Ô¨²³¾±ð°ù´Ç 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| name (obligatorio) |
cadena | Nombre del encabezado / variable / campo de POST o GET. |