Sidebar
fr:manual:api:reference:service:get
Table of Contents
service.get
Description
integer/array service.get(object parameters)
La méthode permet de récupérer des services en fonction des paramètres donnés.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| serviceids | string/array | Renvoie uniquement les services avec les identifiants donnés. |
| parentids | string/array | Renvoie uniquement les services avec des dépendances parents dures données. |
| childids | string/array | Renvoie uniquement les services avec des dépendances enfants dures sur les services enfants donnés. |
| selectParent | query | Renvoie le service parent à dépendance dure dans la propriété parent. |
| selectDependencies | query | Renvoie les dépendances enfants dans la propriété dependencies. |
| selectParentDependencies | query | Renvoie les dépendances enfants dans la propriété parentDependencies. |
| selectTimes | query | Renvoie les périodes de maintenance dans la propriété times. |
| selectAlarms | query | Renvoie les alarmes de service dans la propriété alarms. |
| selectTrigger | query | Renvoie les déclencheurs associés dans la propriété trigger. |
| sortfield | string/array | Trie le résultat en fonction des propriétés données. Valeurs possibles : name et sortorder. |
| 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
countOutputa été utilisé.
Exemples
Récupération de tous les services
Récupérer toutes les données de tous les services et leurs dépendances.
Requête :
{ "jsonrpc": "2.0", "method": "service.get", "params": { "output": "extend", "selectDependencies": "extend" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": [ { "serviceid": "2", "name": "Server 1", "status": "0", "algorithm": "1", "triggerid": "0", "showsla": "1", "goodsla": "99.9000", "sortorder": "0", "dependencies": [] }, { "serviceid": "3", "name": "Data center 1", "status": "0", "algorithm": "1", "triggerid": "0", "showsla": "1", "goodsla": "99.9000", "sortorder": "0", "dependencies": [ { "linkid": "11", "serviceupid": "3", "servicedownid": "2", "soft": "0", "sortorder": "0", "serviceid": "2" }, { "linkid": "10", "serviceupid": "3", "servicedownid": "5", "soft": "0", "sortorder": "1", "serviceid": "5" } ] }, { "serviceid": "5", "name": "Server 2", "status": "0", "algorithm": "1", "triggerid": "0", "showsla": "1", "goodsla": "99.9900", "sortorder": "1", "dependencies": [] } ], "id": 1 }
Source
CService::get() dans frontends/php/include/classes/api/services/CService.php.