Documentation
Table of Contents
sla.getsli
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
object sla.getsli(object parameters)
Aquest m¨¨tode permet calcular les dades de l'indicador de nivell de servei (SLI) per al Service Level Agreement (SLA).
Aquest m¨¨tode ¨¦s disponible per a qualsevol mena d'usuaris. Els permisos per cridar al m¨¨tode es poden revocar a la configuraci¨® de rols d'usuaris. Per a m¨¦s informaci¨®, veieu Rols d'usuari.
±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ
(objecte) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que contenen l'ID de l'SLA, els ±è±ð°ù¨ª´Ç»å±ð²õ d'informe i, opcionalment, els ID dels serveis - emprats per calcular l'SLI.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| slaid | ID | IDs dels serveis per als quals retornar informaci¨® de disponibilitat. Comportament del par¨¤metre: - obligatori |
| period_from | timestamp | Data d'inici (inclosa) per a informar l'SLI. Valor possible: marca de temps. |
| period_to | timestamp | Data de finalitzaci¨® (exclusiva) per a la qual es notifica l'SLI. Valor possible: marca de temps. |
| periods | matriu | Nombre preferit de ±è±ð°ù¨ª´Ç»å±ð²õ per informar. Valors possibles: 1-100 |
| serviceids | ID/array | ID dels serveis per als quals retornar l'SLI. |
Partici¨® de ±è±ð°ù¨ª´Ç»å±ð²õ
La taula seg¨¹ent mostra la disposici¨® dels segments de per¨ªode retornats en funci¨® de combinacions de par¨¤metres.
Els ±è±ð°ù¨ª´Ç»å±ð²õ retornats no precederan el primer per¨ªode disponible en funci¨® de la data d'entrada en vigor de l'SLA i no superaran el per¨ªode actual.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® | ||
|---|---|---|---|
| ±è±ð°ù¨ª´Ç»å±ð³å»å±ð | ±è±ð°ù¨ª´Ç»å±ð³å²¹ | ±è±ð°ù¨ª´Ç»å±ð²õ | |
| - | - | - | Retorna els darrers 20 ±è±ð°ù¨ª´Ç»å±ð²õ. |
| - | - | especificat | Retorna els ¨²ltims ±è±ð°ù¨ª´Ç»å±ð²õ especificats pel par¨¤metre ±è±ð°ù¨ª´Ç»å±ð²õ. |
| - | especificat | - | Retorna els darrers 20 ±è±ð°ù¨ª´Ç»å±ð²õ abans de la data especificada ±è±ð°ù¨ª´Ç»å±ð³å²¹. |
| - | especificat | especificat | Retorna els ¨²ltims ±è±ð°ù¨ª´Ç»å±ð²õ especificats pel par¨¤metre ±è±ð°ù¨ª´Ç»å±ð²õ abans de la data especificada ±è±ð°ù¨ª´Ç»å±ð³å²¹. |
| especificat | - | - | Retorna els primers 20 ±è±ð°ù¨ª´Ç»å±ð²õ a partir de la data especificada ±è±ð°ù¨ª´Ç»å±ð³å²¹ partir de. |
| especificat | - | especificat | Retorna els primers ±è±ð°ù¨ª´Ç»å±ð²õ especificats pel par¨¤metre ±è±ð°ù¨ª´Ç»å±ð²õ comen?ant per la data especificada ±è±ð°ù¨ª´Ç»å±ð³å²¹ partir de. |
| especificat | especificat | - | Retorna fins a 100 ±è±ð°ù¨ª´Ç»å±ð²õ dins de l'interval de dates especificat. |
| especificat | especificat | especificat | Per¨ªodes de retorn especificats pel par¨¤metre ±è±ð°ù¨ª´Ç»å±ð²õ dins de l'interval de dates especificat. |
Valors de retorn
(objecte) Retorna els resultats del c¨¤lcul.
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| periods | matriu | Llista dels ±è±ð°ù¨ª´Ç»å±ð²õ informats. Cada per¨ªode informat es representa com un objecte format per: - period_from - Data d'inici del per¨ªode informat (marca de temps).- period_to: data de finalitzaci¨® del per¨ªode informat (marca de temps).Els ±è±ð°ù¨ª´Ç»å±ð²õ s'ordenen per camp period_from ascendent. |
| serviceids | matriu | Llista d'ID de servei en els ±è±ð°ù¨ª´Ç»å±ð²õ informats. L'ordre d'ordenaci¨® de la llista no ¨¦s definit. Fins i tot si el par¨¤metre serviceids es va passar al m¨¨tode sla.getsli. |
| sli | matriu | SLI dades (com a matriu bidimensional) per a cada per¨ªode i servei informats. L'¨ªndex de la propietat periods s'empra com a primera dimensi¨® de la propietat sli.L'¨ªndex de la propietat serviceids s'empra com a segona dimensi¨® de la propietat sli. |
Informaci¨® SLI
Les dades SLI retornades per a cada per¨ªode i servei informats consisteixen en:
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| uptime | enter | Quantitat de temps de servei en estat OK durant el temps d'activitat programat, menys els temps d'inactivitat exclosos. |
| temps d'inactivitat | enter | Quantitat de temps que s'empra el servei en un estat no correcte durant el temps d'activitat programat, menys els temps d'inactivitat exclosos. |
| sli | flotant | SLI (percentatge del temps d'activitat total), basat en temps d'activitat i temps d'inactivitat. |
| error_budget | enter | Pressupost d'error (en segons), basat en l'SLI i l'SLO. |
| excluded_downtimes | array | Matriu de temps d'inactivitat exclosos en aquest per¨ªode d'informe. Cada objecte contindr¨¤ els par¨¤metres seg¨¹ents: - name - Nom del temps d'inactivitat excl¨°s.- period_from - Data i hora d'inici (incloses) del temps d'inactivitat excl¨°s.- period_to - Data i hora de finalitzaci¨® (exclosa) del temps d'inactivitat excl¨°s.Els temps d'inactivitat exclosos s'ordenen per period_from camp ascendent. |
Exemples
Calcular SLI
Retorna SLI als servis amb IDs "50", "60" i "70" enlla?ats a un SLA amb ID de "5". Retorna la data per 3 ±è±ð°ù¨ª´Ç»å±ð²õ des de l'1 de Novembre de 2021.
{
"jsonrpc": "2.0",
"method": "sla.getsli",
"params": {
"slaid": "5",
"serviceids": [
50,
60,
70
],
"periods": 3,
"period_from": "1635724800"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": {
"periods": [
{
"period_from": 1635724800,
"period_to": 1638316800
},
{
"period_from": 1638316800,
"period_to": 1640995200
},
{
"period_from": 1640995200,
"period_to": 1643673600
}
],
"serviceids": [
50,
60,
70
],
"sli": [
[
{
"uptime": 1186212,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": [
{
"name": "Excluded Downtime - 1",
"period_from": 1637836212,
"period_to": 1638316800
}
]
},
{
"uptime": 1186212,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": [
{
"name": "Excluded Downtime - 1",
"period_from": 1637836212,
"period_to": 1638316800
}
]
},
{
"uptime": 1186212,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": [
{
"name": "Excluded Downtime - 1",
"period_from": 1637836212,
"period_to": 1638316800
}
]
}
],
[
{
"uptime": 1147548,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": [
{
"name": "Excluded Downtime - 1",
"period_from": 1638439200,
"period_to": 1639109652
}
]
},
{
"uptime": 1147548,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": [
{
"name": "Excluded Downtime - 1",
"period_from": 1638439200,
"period_to": 1639109652
}
]
},
{
"uptime": 1147548,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": [
{
"name": "Excluded Downtime - 1",
"period_from": 1638439200,
"period_to": 1639109652
}
]
}
],
[
{
"uptime": 1674000,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": []
},
{
"uptime": 1674000,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": []
},
{
"uptime": 1674000,
"downtime": 0,
"sli": 100,
"error_budget": 0,
"excluded_downtimes": []
}
]
]
},
"id": 1
}Font
CSla::getSli() in ui/include/classes/api/services/CSla.php