httptest.get

Descripción

integer/array httptest.get(object parameters)

El método permite recuperar escenarios web según los parámetros dados.

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

Parámetros

(object) Parámetros que definen el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
groupids ID/array Devuelve únicamente los escenarios web que pertenecen a los grupos de hosts indicados.
hostids ID/array Devuelve únicamente los escenarios web que pertenecen a los hosts indicados.
httptestids ID/array Devuelve únicamente los escenarios web con los ID indicados.
inherited boolean Si se establece en true, devuelve únicamente los escenarios web heredados de un template.
monitored boolean Si se establece en true, devuelve únicamente los escenarios web habilitados que pertenecen a hosts monitorizados.
templated boolean Si se establece en true, devuelve únicamente los escenarios web que pertenecen a templates.
templateids ID/array Devuelve únicamente los escenarios web que pertenecen a los templates indicados.
expandName flag Expande las macros en el nombre del escenario web.
expandStepName flag Expande las macros en los nombres de los pasos del escenario.
evaltype integer Método de evaluación de etiquetas.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
tags array Devuelve únicamente los escenarios web con las etiquetas indicadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Una matriz vacía devuelve todos los escenarios web.

Valores posibles de operador:
0 - (predeterminado) Contiene;
1 - Es igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
selectHosts query Devuelve los hosts a los que pertenece el escenario web como una matriz en la propiedad hosts.
selectSteps query Devuelve los pasos del escenario web en la propiedad steps.

Admite count.
selectTags query Devuelve las etiquetas del escenario web en la propiedad tags.
sortfield string/array Ordena el resultado según las propiedades indicadas.

Valores posibles: httptestid, name.
countOutput boolean Estos parámetros se describen en los comentarios de referencia.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(entero/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar un escenario web

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

Request:

{
    "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

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