httptest.get

Beschreibung

integer/array httptest.get(object parameters)

Die Methode ermöglicht es Ihnen, Webszenarien anhand der angegebenen Parameter abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

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

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
groupids ID/array Gibt nur Webszenarien zurück, die zu den angegebenen Host-Gruppen gehören.
hostids ID/array Gibt nur Webszenarien zurück, die zu den angegebenen Hosts gehören.
httptestids ID/array Gibt nur Webszenarien mit den angegebenen IDs zurück.
inherited boolean Wenn auf true gesetzt, werden nur Webszenarien zurückgegeben, die von einer Vorlage geerbt wurden.
inheritedTags boolean Gibt Webszenarien zurück, die die angegebenen tags auch in Vorlage/Host/verknüpften Vorlagen haben.

Mögliche Werte:
true - Vorlage/Host/verknüpfte Vorlagen müssen die angegebenen Tags ebenfalls haben;
false - (Standard) Tags aus Vorlage/Host/verknüpften Vorlagen werden ignoriert.
monitored boolean Wenn auf true gesetzt, werden nur aktivierte Webszenarien zurückgegeben, die zu überwachten Hosts gehören.
selectInheritedTags query Gibt eine Eigenschaft inheritedTags mit Tags zurück, die sich auf Vorlage/Host/verknüpften Vorlagen befinden.
templated boolean Wenn auf true gesetzt, werden nur Webszenarien zurückgegeben, die zu Vorlagen gehören.
templateids ID/array Gibt nur Webszenarien zurück, die zu den angegebenen Vorlagen gehören.
expandName flag Erweitert Makros im Namen des Webszenarios.
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 Webszenarien mit den angegebenen Tags zurück.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Webszenarien zurück.

Mögliche Werte für operator:
0 - (Standard) Enthält;
1 - Gleich;
2 - Enthält nicht;
3 - Ungleich;
4 - Existiert;
5 - Existiert nicht.
selectHosts query Gibt die Hosts, zu denen das Webszenario gehört, als Array in der Eigenschaft hosts zurück.
selectSteps query Gibt Webszenarioschritte in der Eigenschaft steps zurück.

Unterstützt count.
selectTags query Gibt Webszenario-Tags 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 sind 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 Webszenarios

Rufen Sie alle Daten zum Webszenario „9“ ab.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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