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 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 pertenecen a los grupos de hosts indicados.
hostids ID/array Devolver solo los escenarios web que pertenecen a los hosts indicados.
httptestids ID/array Devolver solo los escenarios web con los IDs indicados.
inherited boolean Si se establece en true, devuelve solo los escenarios web heredados de una template.
inheritedTags boolean Devuelve los escenarios web que tienen las tags indicadas también en la template/host/templates vinculadas.

Valores posibles:
true - la template/host/templates vinculadas también deben tener las tags indicadas;
false - (por defecto) se ignoran las tags de la template/host/templates vinculadas.
monitored boolean Si se establece en true, devuelve solo los escenarios web habilitados que pertenecen a hosts monitorizados.
selectInheritedTags query Devuelve una propiedad inheritedTags con las tags que están en la template/host/templates vinculadas.
templated boolean Si se establece en true, devuelve solo los escenarios web que pertenecen a templates.
templateids ID/array Devolver solo los escenarios web que pertenecen a las templates indicadas.
expandName flag Expande macros en el nombre del escenario web.
expandStepName flag Expande macros en los nombres de los pasos del escenario.
evaltype integer Método de evaluación de las tags.

Valores posibles:
0 - (por defecto) And/Or;
2 - Or.
tags array Devolver solo los escenarios web con las tags indicadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vacío devuelve todos los escenarios web.

Valores posibles de operator:
0 - (por defecto) Contiene;
1 - 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 un array en la propiedad hosts.
selectSteps query Devuelve los pasos del escenario web en la propiedad steps.

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

Valores posibles: httptestid, name.
countOutput boolean Estos parámetros se describen en el comentario 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

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

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",
            "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",
            "uuid": "",
            "headers": [],
            "variables": [],
            "steps": [
                {
                    "httpstepid": "36",
                    "httptestid": "9",
                    "name": "Homepage",
                    "no": "1",
                    "url": "http://example.com",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "post_type": "1",
                    "headers": [],
                    "variables": [
                        {
                            "name":"{var}",
                            "value":"12"
                        }
                    ],
                    "query_fields": []
                },
                {
                    "httpstepid": "37",
                    "httptestid": "9",
                    "name": "Homepage / About",
                    "no": "2",
                    "url": "http://example.com/about",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "post_type": "1",
                    "headers": [],
                    "variables": [],
                    "query_fields": []
                }
            ]
        }
    ],
    "id": 1
}

Ver también

Fuente

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