sla.get

Descripción

integer/array sla.get(object parameters)

El método permite recuperar objetos SLA según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
slaids cadena/matriz Devuelve solo SLA con los ID proporcionados.
serviceids cadena/matriz Devuelve solo SLA que coincidan con los servicios específicos.
selectSchedule consulta Devuelve una propiedad schedule con programaciones SLA.

Admite count.
selectExcludedDowntimes consulta Devuelve una propiedad excluded_downtimes con tiempos de inactividad excluidos por SLA.

Admite count.
selectServiceTags consulta Devuelve una propiedad service_tags con etiquetas de servicio SLA.

Admite count.
sortfield cadena/matriz Ordena el resultado por las propiedades dadas.

Valores posibles: slaid, name, period, slo, Effective_date, timezone, status, descripción.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
startSearch booleano

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperando todos los SLA

Recupere todos los datos sobre todos los SLA y sus propiedades.

Solicitud:

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

Respuesta:

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

Fuente

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