Documentation
Table of Contents
sla.getsli
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
object sla.getsli(object parameters)
Este m¨¦todo permite calcular los datos del Indicador de Nivel de Servicio (SLI) para un Acuerdo de Nivel de Servicio (SLA).
Este m¨¦todo est¨¢ disponible para usuarios de cualquier tipo. Los permisos para llamar al m¨¦todo se pueden revocar en la configuraci¨®n de roles de usuario. Ver Roles de usuario para obtener m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que contienen el ID del SLA, ±è±ð°ù¨ª´Ç»å´Ç²õ de informe y, opcionalmente, los ID de los servicios - para calcular el SLI.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| slaid | cadena | ID del SLA para el cual devolver informaci¨®n de disponibilidad. Comportamiento del par¨¢metro: - requerido |
| period_from | marca de tiempo | Fecha de inicio (inclusive) para informar el SLI. Valores posibles: marca de tiempo. |
| period_to | marca de tiempo | Fecha de finalizaci¨®n (exclusiva) para informar el SLI. Valores posibles: marca de tiempo. |
| periods | matriz | N¨²mero preferido de ±è±ð°ù¨ª´Ç»å´Ç²õ para informar. Valores posibles: 1-100 |
| serviceids | cadena/matriz | ID de servicios para los que devolver el SLI. |
Partici¨®n de ±è±ð°ù¨ª´Ç»å´Ç²õ
La siguiente tabla muestra la disposici¨®n de los sectores del per¨ªodo devuelto en funci¨®n de combinaciones de par¨¢metros.
Los ±è±ð°ù¨ª´Ç»å´Ç²õ devueltos no preceder¨¢n al primer per¨ªodo disponible seg¨²n la fecha de vigencia del SLA y no exceder¨¢n el per¨ªodo actual.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô | ||
|---|---|---|---|
| ±è±ð°ù¨ª´Ç»å´Ç³å»å±ð²õ»å±ð | ±è±ð°ù¨ª´Ç»å´Ç³å³ó²¹²õ³Ù²¹ | ±è±ð°ù¨ª´Ç»å´Ç²õ | |
| - | - | - | Devuelve los ¨²ltimos 20 periodos. |
| - | - | especificado | Devuelve los ¨²ltimos ±è±ð°ù¨ª´Ç»å´Ç²õ especificados por el par¨¢metro periodos. |
| - | especificado | - | Devuelve los ¨²ltimos 20 ±è±ð°ù¨ª´Ç»å´Ç²õ antes de la fecha period_to especificada. |
| - | especificado | especificado | Devuelve los ¨²ltimos ±è±ð°ù¨ª´Ç»å´Ç²õ especificados por el par¨¢metro periods antes de la fecha period_to especificada. |
| especificado | - | - | Devuelve los primeros 20 ±è±ð°ù¨ª´Ç»å´Ç²õ que comienzan con la fecha especificada period_from. |
| especificado | - | especificado | Devuelve los primeros ±è±ð°ù¨ª´Ç»å´Ç²õ especificados por el par¨¢metro periods comenzando con la fecha period_from especificada. |
| especificado | especificado | - | Devuelve hasta 100 ±è±ð°ù¨ª´Ç»å´Ç²õ dentro del rango de fechas especificado. |
| especificado | especificado | especificado | Per¨ªodos de retorno especificados por el par¨¢metro periodos dentro del rango de fechas especificado. |
Valores de retorno
(objeto) Devuelve los resultados del c¨¢lculo.
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| periods | matriz | Lista de los ±è±ð°ù¨ª´Ç»å´Ç²õ reportados. Cada per¨ªodo reportado se representa como un objeto que consta de: - period_from - Fecha de inicio del per¨ªodo reportado (marca de tiempo).- period_to - Fecha de finalizaci¨®n del per¨ªodo informado (marca de tiempo).Los ±è±ð°ù¨ª´Ç»å´Ç²õ se ordenan seg¨²n el campo period_from de forma ascendente. |
| serviceids | matriz | Lista de ID de servicios en los ±è±ð°ù¨ª´Ç»å´Ç²õ informados. El orden de clasificaci¨®n de la lista no est¨¢ definido. Incluso si el par¨¢metro serviceids se pas¨® al m¨¦todo sla.getsli. |
| sli | matriz | Datos SLI (como una matriz bidimensional) para cada per¨ªodo y servicio informado. El ¨ªndice de la propiedad periods se utiliza como la primera dimensi¨®n de la propiedad sli.El ¨ªndice de la propiedad serviceids se utiliza como segunda dimensi¨®n de la propiedad sli. |
Datos SLI
Los datos de SLI devueltos para cada per¨ªodo y servicio reportado consisten en:
| Propiedad | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| uptime | entero | Cantidad de tiempo que el servicio pas¨® en estado OK durante el tiempo de actividad programado, menos los tiempos de inactividad excluidos. |
| downtime | entero | Cantidad de tiempo que el servicio pas¨® en un estado no correcto durante el tiempo de actividad programado, menos los tiempos de inactividad excluidos. |
| sli | float | SLI (porcentaje del tiempo de actividad total), basado en el tiempo de actividad y el tiempo de inactividad. |
| error_budget | entero | Presupuesto de error (en segundos), basado en SLI y SLO. |
| excluded_downtimes | matriz | Matriz de tiempos de inactividad excluidos en este per¨ªodo de informe. Cada objeto contendr¨¢ los siguientes par¨¢metros: - name: nombre del tiempo de inactividad excluido.- period_from - Fecha y hora de inicio (inclusive) del tiempo de inactividad excluido.- period_to - Fecha y hora de finalizaci¨®n (exclusivas) del tiempo de inactividad excluido.Los tiempos de inactividad excluidos se ordenan por campo period_from de forma ascendente. |
Ejemplos
Calcular el SLI
Recupere datos de SLI sobre servicios con ID "50", "60" y "70" que est¨¢n vinculados al SLA con ID "5". Recuperar datos de 3 ±è±ð°ù¨ª´Ç»å´Ç²õ a partir del 01 de noviembre de 2021.
{
"jsonrpc": "2.0",
"method": "sla.getsli",
"params": {
"slaid": "5",
"serviceids": [
50,
60,
70
],
"periods": 3,
"period_from": "1635724800"
},
"id": 1
}Respuesta:
{
"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
}Fuente
CSla::getSli() en ui/include/classes/api/services/CSla.php