sla.get

Descripció

integer/array sla.get(object parameters)

El mètode permet recuperar objectes SLA segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres definint la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
slaids string/array Retorneu només els SLA amb els identificadors proporcionats.
serviceids string/array Retorneu només els SLA corresponents als serveis específics.
selectSchedule query Retorna una propietat schedule amb programacions de SLA.

Admet count.
selectExcludedDowntimes query Retorna una propietat excluded_downtimes amb els temps d'inactivitat exclosos del SLA.

Admet count.
selectServiceTags query Retorna una propietat service_tags amb etiquetes de servei SLA.

Admet count.
sortfield string/array Ordena el resultat segons les propietats donades.

Els valors possibles són: slaid, name, period, slo, effective_date, timezone, status i ` descripció'.
countOutput boolean Aquests paràmetres es descriuen en detall a la pàgina comentaris de referència.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar tots els SLAs

Recuperar tota la informació de tots els SLAs i les seves propietats.

Petició:

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

Resposta:

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

Font

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