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. Permisos para activar el método se puede revocar en los ajustes de roles de usuario. Ver User roles para más información.

Parámetros

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

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
groupids	cadena/matriz	Devuelve solo escenarios web que pertenecen a los grupos de hosts dados.
hostids	cadena/matriz	Devuelve sólo escenarios web que pertenecen a los hosts dados.
httptestids	cadena/matriz	Devuelve solo escenarios web con los IDs proporcionados.
heredado	booleano	Si se establece en "verdadero", devuelve solo escenarios web heredados de una template.
monitoreado	booleano	Si se establece en "verdadero", solo se devuelven escenarios web habilitados que pertenecen a hosts monitoreados.
templated	booleano	Si se establece en "verdadero", devuelve solo escenarios web que pertenecen a templates.
templateids	cadena/matriz	Devuelve solo escenarios web que pertenecen a las templates dadas.
expandName	flag	Expandir macros en el nombre del escenario web.
expandStepName	flag	Ampliar macros en los nombres de los pasos del escenario.
evaltype	número entero	Reglas para la búsqueda de etiquetas. Valores posibles: 0 - (predeterminado) Y/O; 2 - O.
etiquetas	matriz de objetos	Devuelve solo escenarios web con etiquetas dadas. Coincidencia exacta por etiqueta y búsqueda que distinga entre mayúsculas y minúsculas por valor de etiqueta según el valor del operador. Formato: `[{"tag": "<tag>", "value": "<value>", " operador": "<operador>"}, ...]`. Una matriz vacía devuelve todos los escenarios web. Tipos de operadores posibles: 0 - (predeterminado) Me gusta; 1 - Igual; 2 - No me gusta; 3 - No igual 4 - Existe; 5 - No existe.
selectHosts	consulta	Devuelve los hosts a los que pertenece el escenario web como una matriz en la propiedad hosts.
selectSteps	consulta	Devuelve los pasos del escenario web en la propiedad pasos. Admite `count`.
selectTags	consulta	Devuelve las etiquetas del escenario web en la propiedad tags.
sortfield	cadena/matriz	Ordena el resultado según las propiedades dadas. Los valores posibles son: `httptestid` y `name`.
countOutput	booleano	Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en el reference commentary.
editable	booleano
excluirBuscar	booleano
filtro	objeto
límite	número entero
salida	consulta
preservekeys	booleano
buscar	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
clasificación	cadena/matriz
iniciarBuscar	booleano

Valores de retorno

(integer/array) 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"
       },
       "auth": "038e1d7b1735c6a5436ee9eae095879e",
       "id": 1
       }

Respuesta:

{
       "jsonrpc": "2.0",
       "result": [
       {
       "httptestid": "9",
       "name": "Homepage check",
       "nextcheck": "0",
       "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.

Documentation