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.

Parameter Type Description
groupids ID/array Devolver solo escenarios web que pertenezcan a los grupos de host indicados.
hostids ID/array Devolver solo escenarios web que pertenezcan a los hosts indicados.
httptestids ID/array Devolver solo escenarios web con los IDs indicados.
inherited boolean Si se establece en true, devolver solo escenarios web heredados de un template.
monitored boolean Si se establece en true, devolver solo escenarios web habilitados que pertenezcan a hosts monitorizados.
templated boolean Si se establece en true, devolver solo escenarios web que pertenezcan a templates.
templateids ID/array Devolver solo escenarios web que pertenezcan a los templates indicados.
expandName flag Expandir macros en el nombre del escenario web.
expandStepName flag Expandir 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 Devolver solo escenarios web con las etiquetas indicadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vacío devuelve todos los escenarios web.

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

Admite count.
selectTags query 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 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

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.