sla.get

Description

integer/array sla.get(object parameters)

La méthode permet de récupérer des objets SLA selon les paramètres fournis.

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.

Paramètre Type Description
slaids ID/array Retourner uniquement les SLA avec les ID donnés.
serviceids ID/array Retourner uniquement les SLA correspondant aux services spécifiés.
selectSchedule query Retourner une propriété schedule avec les planifications des SLA.

Prend en charge count.
selectExcludedDowntimes query Retourner une propriété excluded_downtimes avec les temps d'arrêt exclus des SLA.

Prend en charge count.
selectServiceTags query Retourner une propriété service_tags avec les tags de service des SLA.

Prend en charge count.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : slaid, name, period, slo, effective_date, timezone, status, description.
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 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
    },
    "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.