[comment]: # ({0d3af930-0d3af930})
# maintenance.get

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

[comment]: # ({9b458513-a04dd4c9})
### Descrição

`integer/array maintenance.get(object parameters)`

O método permite recuperar manutenções de acordo com os parâmetros fornecidos.

::: noteclassic
Este método está disponível para usuários de qualquer tipo.
As permissões para chamar o método podem ser revogadas nas configurações de função do usuário.
Consulte [Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::

[comment]: # ({/9b458513-a04dd4c9})

[comment]: # ({5e94d811-9ca798d7})
### Parâmetros

`(object)` Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|groupids|ID/array|Retorna apenas manutenções atribuídas aos grupos de hosts fornecidos.|
|hostids|ID/array|Retorna apenas manutenções atribuídas aos hosts fornecidos.|
|maintenanceids|ID/array|Retorna apenas manutenções com os IDs fornecidos.|
|selectHostGroups|query|Retorna uma propriedade [`hostgroups`](/manual/api/reference/hostgroup/object) com os grupos de hosts atribuídos à manutenção.|
|selectHosts|query|Retorna uma propriedade [`hosts`](/manual/api/reference/host/object) com os hosts atribuídos à manutenção.|
|selectTags|query|Retorna uma propriedade [`tags`](/manual/api/reference/maintenance/object#problem-tag) com as tags de problema da manutenção.|
|selectTimeperiods|query|Retorna uma propriedade [`timeperiods`](/manual/api/reference/maintenance/object#time-period) com os períodos de tempo da manutenção.|
|sortfield|string/array|Ordena o resultado pelas propriedades fornecidas.<br><br>Valores possíveis: `maintenanceid`, `name`, `maintenance_type`, `active_since`, `active_till`.|
|countOutput|boolean|Esses parâmetros são descritos no [comentário de referência](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/5e94d811-9ca798d7})

[comment]: # ({07ca11ca-7223bab1})
### Valores de retorno

`(integer/array)` Retorna:

-   um array de objetos;
-   a contagem de objetos recuperados, se o parâmetro `countOutput` foi usado.

[comment]: # ({/07ca11ca-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({f81f6983-0b1cb387})
#### Recuperando manutenções

Recupere todas as manutenções configuradas e os dados sobre os grupos de hosts atribuídos, períodos de tempo definidos e tags de problemas.

[Requisição](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectTimeperiods": "extend",
        "selectTags": "extend"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "maintenanceid": "3",
            "name": "Sunday maintenance",
            "maintenance_type": "0",
            "description": "",
            "active_since": "1358844540",
            "active_till": "1390466940",
            "tags_evaltype": "0",
            "hostgroups": [
                {
                    "groupid": "4",
                    "name": "Zabbix servers",
                    "flags": "0",
                    "uuid": "6f6799aa69e844b4b3918f779f2abf08"
                }
            ],
            "timeperiods": [
                {
                    "timeperiod_type": "3",
                    "every": "1",
                    "month": "0",
                    "dayofweek": "1",
                    "day": "0",
                    "start_time": "64800",
                    "period": "3600",
                    "start_date": "2147483647"
                }
            ],
            "tags": [
                {
                    "tag": "service",
                    "operator": "0",
                    "value": "mysqld",
                },
                {
                    "tag": "error",
                    "operator": "2",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}
```

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

[comment]: # ({c56425b7-dbcf678a})
### Veja também

-   [Host](/manual/api/reference/host/object#host)
-   [Grupo de hosts](/manual/api/reference/hostgroup/object#host-group)
-   [Período de tempo](object#time-period)

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

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

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

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