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.

Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

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

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
groupids string/array Renvoyer uniquement les scénarios Web appartenant aux groupes d'hôtes donnés.
hostids string/array Renvoyer uniquement les scénarios Web qui appartiennent aux hôtes donnés.
httptestids string/array Renvoyer uniquement les scénarios Web avec les ID 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.
templed booléen Si défini àtrue, renvoie uniquement les scénarios Web appartenant aux modèles.
templateids string/array Renvoyer uniquement les scénarios Web qui appartiennent 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 des étapes de scénario.
evaltype integer Règles de recherche de tags.

Valeurs possibles :
0 - (par défaut) Et/Ou ;
2 - Ou.
tags tableau d'objets Renvoyer uniquement les scénarios Web avec des tags données. Correspondance exacte par tag et recherche sensible ou insensible à la casse par valeur de tag en fonction de la valeur de l'opérateur.
Format : [{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...].
Un tableau vide renvoie tous les scénarios Web.

Types d'opérateurs possibles :
0 - (par défaut) Comme ;
1 - Égal ;
2 - Pas comme ;
3 - Pas égal
4 - Existe ;
5 - N'existe pas.
selectHosts query Renvoie les hôtes auxquels appartient le scénario Web sous la forme d'un tableau dans la propriété hosts.
selectSteps query Renvoyer les étapes du scénario Web dans la propriété steps.

Prend en charge count.
selectTags query Renvoyer les tags de scénario Web dans la propriété tags.
sortfield string/array Trier le résultat selon les propriétés données.

Les valeurs possibles sont : 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érez toutes les données sur le 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",
                   "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://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
       }

Voir également

Source

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