sla.get

Description

integer/array sla.get(object parameters)

La méthode permet de récupérer des objets SLA 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

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

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

Paramètre	Type	Description
slaids	string/array	Renvoie uniquement les SLA avec les ID donnés.
serviceids	string/array	Renvoie uniquement les SLA correspondant aux services spécifiques.
selectSchedule	query	Renvoie une propriété `schedule` avec les planifications SLA. Prend en charge `count`.
selectExcludedDowntimes	query	Renvoie une propriété `excluded_downtimes` avec les temps d'arrêt exclus du SLA. Prend en charge `count`.
selectServiceTags	query	Renvoie une propriété `service_tags` avec des tags de service SLA. Prend en charge `count`.
sortfield	string/array	Trie le résultat selon les propriétés données. Les valeurs possibles sont : `slaid`, `name`, `period`, `slo`, `effective_date`, `timezone`, `status` et `description`.
countOutput	boolean	Ces paramètres communs à toutes les méthodes `get` sont décrits en détail dans la page de 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 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 de tous les SLA

Récupérez toutes les données sur tous les SLA et leurs propriétés.

Requête :

{
           "jsonrpc": "2.0",
           "method": "sla.get",
           "params": {
               "output": "extend",
               "selectSchedule": ["period_from", "period_to"],
               "selectExcludedDowntimes": ["name", "period_from", "period_to"],
               "selectServiceTags": ["tag", "operator", "value"],
               "preservekeys": true
           },
           "auth": "85dd04b94cbfad794616eb923be13c71",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": {
               "1": {
                   "slaid": "1",
                   "name": "Database Uptime",
                   "period": "1",
                   "slo": "99.9995",
                   "effective_date": "1672444800",
                   "timezone": "America/Toronto",
                   "status": "1",
                   "description": "Provide excellent uptime for main SQL database engines.",
                   "service_tags": [
                       {
                           "tag": "Database",
                           "operator": "0",
                           "value": "MySQL"
                       },
                       {
                           "tag": "Database",
                           "operator": "0",
                           "value": "PostgreSQL"
                       }
                   ],
                   "schedule": [
                       {
                           "period_from": "0",
                           "period_to": "601200"
                       }
                   ],
                   "excluded_downtimes": [
                       {
                           "name": "Software version upgrade rollout",
                           "period_from": "1648760400",
                           "period_to": "1648764900"
                       }
                   ]
               }
           },
           "id": 1
       }

Source

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

Documentation