httptest.get

Beschreibung

integer/array httptest.get(object parameters)

Mit dieser Methode können Webszenarien entsprechend den angegebenen Parametern abgerufen werden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
groupids ID/array Nur Web-Szenarien zurückgeben, die zu den angegebenen Hostgruppen gehören.
hostids ID/array Nur Web-Szenarien zurückgeben, die zu den angegebenen Hosts gehören.
httptestids ID/array Nur Web-Szenarien mit den angegebenen IDs zurückgeben.
inherited boolean Wenn auf true gesetzt, nur von einer Vorlage geerbte Web-Szenarien zurückgeben.
monitored boolean Wenn auf true gesetzt, nur aktivierte Web-Szenarien zurückgeben, die zu überwachten Hosts gehören.
templated boolean Wenn auf true gesetzt, nur Web-Szenarien zurückgeben, die zu Vorlagen gehören.
templateids ID/array Nur Web-Szenarien zurückgeben, die zu den angegebenen Vorlagen gehören.
expandName flag Makros im Namen des Web-Szenarios erweitern.
expandStepName flag Makros in den Namen der Szenarioschritte erweitern.
evaltype integer Tag-Auswertungsmethode.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
tags array Nur Web-Szenarien mit den angegebenen Tags zurückgeben.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Web-Szenarien zurück.

Mögliche Operator-Werte:
0 - (Standard) Enthält;
1 - Entspricht;
2 - Enthält nicht;
3 - Entspricht nicht;
4 - Existiert;
5 - Existiert nicht.
selectHosts query Die Hosts, zu denen das Web-Szenario gehört, als Array in der Eigenschaft hosts zurückgeben.
selectSteps query Web-Szenario-Schritte in der Eigenschaft steps zurückgeben.

Unterstützt count.
selectTags query Web-Szenario-Tags in der Eigenschaft tags zurückgeben.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: httptestid, name.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder Folgendes zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Abrufen eines Web-Szenarios

Alle Daten zum Web-Szenario "9" abrufen.

Request:

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

Response:

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

Siehe auch

Quelle

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