maintenance.get

Descripción

integer/array maintenance.get(object parameters)

El método permite recuperar mantenimientos según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración de roles de usuario. Consulte User roles para obtener más información.

Parámetros

(object) Parámetros que definen el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
groupids ID/array Devuelve únicamente los mantenimientos asignados a los grupos de hosts indicados.
hostids ID/array Devuelve únicamente los mantenimientos asignados a los hosts indicados.
triggerids ID/array Devuelve únicamente los mantenimientos asignados a los triggers indicados.
maintenanceids ID/array Devuelve únicamente los mantenimientos con los ID indicados.
selectHostGroups query Devuelve una propiedad hostgroups con los grupos de hosts asignados al mantenimiento.
selectHosts query Devuelve una propiedad hosts con los hosts asignados al mantenimiento.
selectTriggers query Devuelve una propiedad triggers con los triggers asignados al mantenimiento.
selectEventNames query Devuelve una propiedad event_names con los nombres de eventos asignados al mantenimiento.
selectTags query Devuelve una propiedad tags con las etiquetas de problema del mantenimiento.
selectTimeperiods query Devuelve una propiedad timeperiods con los períodos de tiempo del mantenimiento.
sortfield string/array Ordena el resultado por las propiedades indicadas.

Valores posibles: maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Estos parámetros se describen en los comentarios 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/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperación de mantenimientos

Recupere todos los mantenimientos configurados, los datos sobre el alcance del mantenimiento asignado (grupo de hosts, host, trigger, nombre del evento, etiquetas) y los períodos de tiempo definidos.

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectHosts": "extend",
        "selectTriggers": "extend",
        "selectEventNames": "extend",
        "selectTags": "extend",
        "selectTimeperiods": "extend"
    },
    "id": 1
}

Respuesta:


{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "Mantenimiento periódico de la base de datos",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "Bases de datos",
          "flags": "0",
          "uuid": "748ad4d098d447d492bb935c907f652f"
        }
      ],
      "triggers": [],
      "event_names": [],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "4",
          "every": "1",
          "month": "4095",
          "dayofweek": "0",
          "day": "1",
          "start_time": "64800",
          "period": "3600",
          "start_date": "0"
        }
      ]
    },
    {
      "maintenanceid": "2",
      "name": "Ad hoc: Impresora: tinta AGOTADA",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Servidores Zabbix",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "Impresora: tinta AGOTADA"
        }
      ],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "0",
          "every": "1",
          "month": "0",
          "dayofweek": "0",
          "day": "0",
          "start_time": "0",
          "period": "3600",
          "start_date": "1792057740"
        }
      ]
    }
  ],
  "id": 1
}```

[comment]: # ({/ec7146e4-0b1cb387})

[comment]: # ({0c4dce96-dbcf678a})
### Véase también

-   [Host](/manual/api/reference/host/object#host)
-   [Grupo de hosts](/manual/api/reference/hostgroup/object#host-group)
-   [Trigger](/manual/api/reference/trigger/object#trigger)
-   [Nombre del evento](object#event-name)
-   [Etiqueta del problema](object#problem-tag)
-   [Período de tiempo](object#time-period)

[comment]: # ({/0c4dce96-dbcf678a})

[comment]: # ({f0ec3c40-50ed5be3})
### Fuente

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

[comment]: # ({/f0ec3c40-50ed5be3})