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

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

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
slaids ID/array Devolver solo los SLA con los ID dados.
serviceids ID/array Devolver solo los SLA que coincidan con los servicios específicos.
selectSchedule query Devuelve una propiedad schedule con los horarios del SLA.

Admite count.
selectExcludedDowntimes query Devuelve una propiedad excluded_downtimes con los periodos de inactividad excluidos del SLA.

Admite count.
selectServiceTags query Devuelve una propiedad service_tags con las etiquetas de servicio del SLA.

Admite count.
sortfield string/array Ordena el resultado por las propiedades dadas.

Valores posibles: slaid, name, period, slo, effective_date, timezone, status, description.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(entero/matriz) Devuelve:

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

Ejemplos

Recuperación de 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.