httptest.get

Beschreibung

integer/array httptest.get(object parameters)

Mit dieser Methode können Sie Web-Szenarien entsprechend den angegebenen Parametern abrufen.

Diese Methode steht Benutzern jeden Typs zur Verfügung. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter zur Definition der gewünschten Ausgabe.

Die Methode unterstützt die folgenden Parameter.

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

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

Mögliche Werte für Operatoren:
0 - (Standard) Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Existiert;
5 - Existiert nicht.
selectHosts query Gibt die Hosts, zu denen das Web-Szenario gehört, als Array in der Eigenschaft hosts zurück.
selectSteps query Gibt die Schritte des Web-Szenarios in der Eigenschaft steps zurück.

Unterstützt count.
selectTags query Gibt die Tags des Web-Szenarios in der Eigenschaft tags zurück.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: httptestid, name.
countOutput boolean Diese Parameter werden im Referenzkommentar 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.