httptest.get

Description

integer/array httptest.get(object parameters)

Cette méthode permet de récupérer des scénarios web selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

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

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

Parameter Type Description
groupids ID/array Ne retourner que les scénarios web appartenant aux groupes d'hôtes donnés.
hostids ID/array Ne retourner que les scénarios web appartenant aux hôtes donnés.
httptestids ID/array Ne retourner que les scénarios web avec les IDs donnés.
inherited boolean Si défini sur true, ne retourner que les scénarios web hérités d'un modèle.
monitored boolean Si défini sur true, ne retourner que les scénarios web activés appartenant à des hôtes surveillés.
templated boolean Si défini sur true, ne retourner que les scénarios web appartenant à des modèles.
templateids ID/array Ne retourner que 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 des étapes du scénario.
evaltype integer Méthode d'évaluation des balises.

Valeurs possibles :
0 - (par défaut) Et/Ou;
2 - Ou.
tags array Ne retourner que les scénarios web avec les balises données.
Format : [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un tableau vide retourne tous les scénarios web.

Valeurs possibles de operator :
0 - (par défaut) Contient;
1 - Égal à;
2 - Ne contient pas;
3 - Différent de;
4 - Existe;
5 - N'existe pas.
selectHosts query Retourner les hôtes auxquels appartient le scénario web sous forme de tableau dans la propriété hosts.
selectSteps query Retourner les étapes du scénario web dans la propriété steps.

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

Valeurs possibles : httptestid, name.
countOutput boolean Ces paramètres sont décrits dans le commentaire 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 de retour

(integer/array) Renvoie 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 concernant le scénario web "9".

Requête :

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

Réponse :

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

Voir aussi

Source

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