Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

httptest.get

Descripción

integer/array httptest.get(object parameters)

El método permite recuperar escenarios web de acuerdo con los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
groupids ID/array Devolver solo los escenarios web que pertenezcan a los grupos de hosts indicados.
hostids ID/array Devolver solo los escenarios web que pertenezcan a los hosts indicados.
httptestids ID/array Devolver solo los escenarios web con los IDs indicados.
inherited booleano Si se establece en true, devolver solo los escenarios web heredados de una plantilla.
monitored booleano Si se establece en true, devolver solo los escenarios web habilitados que pertenezcan a hosts monitorizados.
templated booleano Si se establece en true, devolver solo los escenarios web que pertenezcan a plantillas.
templateids ID/array Devolver solo los escenarios web que pertenezcan a las plantillas indicadas.
expandName flag Expandir macros en el nombre del escenario web.
expandStepName flag Expandir macros en los nombres de los pasos del escenario.
evaltype entero Reglas para la búsqueda por etiquetas.

Valores posibles:
0 - (por defecto) Y/O;
2 - O.
tags array Devolver solo los escenarios web con las etiquetas indicadas. Coincidencia exacta por etiqueta y búsqueda sensible o no sensible a mayúsculas/minúsculas por valor de etiqueta según el valor del operador.
Formato: [{"tag": "<etiqueta>", "value": "<valor>", "operator": "<operador>"}, ...].
Un array vacío devuelve todos los escenarios web.

Tipos de operador posibles:
0 - (por defecto) Similar;
1 - Igual;
2 - No similar;
3 - No igual;
4 - Existe;
5 - No existe.
selectHosts consulta Devolver los hosts a los que pertenece el escenario web como un array en la propiedad hosts.
selectSteps consulta Devolver los pasos del escenario web en la propiedad steps.

Admite count.
selectTags consulta Devolver las etiquetas del escenario web en la propiedad tags.
sortfield string/array Ordenar el resultado por las propiedades indicadas.

Valores posibles: httptestid, name.
countOutput booleano Estos parámetros se describen en el comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder string/array
startSearch booleano

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperando un escenario web

Recupere todos los datos sobre el escenario web "4".

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "httptest.get",
           "params": {
               "output": "extend",
               "selectSteps": "extend",
               "httptestids": "9"
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "httptestid": "9",
                   "name": "Homepage check",
                   "delay": "1m",
                   "status": "0",
                   "variables": [],
                   "agent": "Zabbix",
                   "authentication": "0",
                   "http_user": "",
                   "http_password": "",
                   "hostid": "10084",
                   "templateid": "0",
                   "http_proxy": "",
                   "retries": "1",
                   "ssl_cert_file": "",
                   "ssl_key_file": "",
                   "ssl_key_password": "",
                   "verify_peer": "0",
                   "verify_host": "0",
                   "headers": [],
                   "steps": [
                       {
                           "httpstepid": "36",
                           "httptestid": "9",
                           "name": "Homepage",
                           "no": "1",
                           "url": "http://example.com",
                           "timeout": "15s",
                           "posts": "",
                           "required": "",
                           "status_codes": "200",
                           "variables": [
                               {
                                   "name":"{var}",
                                   "value":"12"
                               }
                           ],
                           "follow_redirects": "1",
                           "retrieve_mode": "0",
                           "headers": [],
                           "query_fields": []
                       },
                       {
                           "httpstepid": "37",
                           "httptestid": "9",
                           "name": "Homepage / About",
                           "no": "2",
                           "url": "http://example.com/about",
                           "timeout": "15s",
                           "posts": "",
                           "required": "",
                           "status_codes": "200",
                           "variables": [],
                           "follow_redirects": "1",
                           "retrieve_mode": "0",
                           "headers": [],
                           "query_fields": []
                       }
                   ]
               }
           ],
           "id": 1
       }

Ver también

Fuente

CHttpsTest::get() en ui/include/classes/api/services/CHttpsTestt.php.