Sidebar

Zabbix Summit 2022
View presentations

httptest.get

Description

integer/array httptest.get(object parameters)

La méthode permet de récupérer des scénarios Web en fonction des paramètres donnés.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode supporte les paramètres suivants.

Paramètre Type Description
applicationids string/array Renvoie uniquement les scénarios Web appartenant aux applications données.
groupids string/array Renvoie uniquement les scénarios Web appartenant aux groupes d'hôtes donnés.
hostids string/array Renvoie uniquement les scénarios Web appartenant aux hôtes donnés.
httptestids string/array Renvoie uniquement les scénarios Web avec les identifiants donnés.
inherited boolean Si défini à true, ne renvoie que les scénarios Web hérités d'un modèle.
monitored boolean Si défini à true, ne renvoie que les scénarios Web activés appartenant aux hôtes surveillés.
templated boolean Si défini à true, ne renvoie que les scénarios Web appartenant aux modèles.
templateids string/array Renvoie uniquement les scénarios Web appartenant aux modèles donnés.
expandName flag Développer les macros dans le nom du scénario Web.
expandStepName flag Développer les macros dans les noms d'étapes de scénario.
selectHosts query Renvoie les hôtes auquel le scénario Web appartient en tant que tableau dans la propriété hosts.
selectSteps query Renvoie les étapes du scénario Web dans la propriété steps.

Supporte count.
sortfield string/array Trie le résultat en fonction des propriétés données.

Valeurs possibles : httptestid et name.
countOutput boolean Ces paramètres, communs à toutes les méthodes "get", sont décrits dans les commentaires de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs retournées

(integer/array) Retourne soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération d'un scénario Web

Récupérer toutes les données du scénario Web "4".

Requête :

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

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "httptestid": "9",
                   "name": "Homepage check",
                   "applicationid": "0",
                   "nextcheck": "0",
                   "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://mycompany.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://mycompany.com/about",
                           "timeout": "15s",
                           "posts": "",
                           "required": "",
                           "status_codes": "200",
                           "variables": [],
                           "follow_redirects": "1",
                           "retrieve_mode": "0",
                           "headers": [],
                           "query_fields": []
                       }
                   ]
               }
           ],
           "id": 1
       }

Voir également

Source

CHttpTest::get() dans frontends/php/include/classes/api/services/CHttpTest.php.