Gerencia janelas de manutenção, durante as quais os alertas não serão enviados. Use essa API para definir e atualizar as horas de parada e de início, os dispositivos ou sub-redes que devem ser excluídos ao disparar alertas ou para definir e atualizar os mecanismos do Defender para IoT que devem ser excluídos.
Por exemplo, durante uma janela de manutenção, talvez você queira interromper a entrega de todos os alertas, exceto de alertas de malware em dispositivos críticos.
As janelas de manutenção que definem com a API maintenanceWindow aparecem na janela Exclusões de Alerta do console de gerenciamento local como uma regra de exclusão somente leitura, nomeada com a seguinte sintaxe: Maintenance-{token name}-{ticket ID}.
Importante
Essa API é compatível apenas para fins de manutenção e por um período limitado e não deve ser usada no lugar das regras de exclusão de alerta. Use essa API somente para operações de manutenção temporárias e avulsas.
Cadeia de caracteres. Define a ID do tíquete de manutenção nos sistemas do usuário. Verifique se a ID do tíquete não está vinculada a uma janela aberta existente.
2987345p98234
Obrigatório
ttl
Número inteiro positivo. Define a TTL (vida útil), que é a duração da janela de manutenção em minutos. Após o término do período definido, a janela de manutenção terminará e o sistema se comportará normalmente novamente.
180
Obrigatório
engines
Matriz JSON de strings. Define qual mecanismo suprime os alertas durante a janela de manutenção. Valores possíveis:
Matriz JSON de strings. Define quais sensores suprimem os alertas durante a janela de manutenção. Você pode obter essas IDs do sensor na API devices (Gerenciar dispositivos de sensor OT).
1,35,63
Opcional
sub-redes
Matriz JSON de strings. Define as sub-redes para supressão de alertas durante a janela de manutenção. Defina cada sub-rede em uma notação CIDR.
192.168.0.0/16,138.136.80.0/14,112.138.10.0/8
Opcional
Código de status
Mensagem
Descrição
201 (Criado)
-
A ação foi concluída com êxito.
400 (Solicitação inválida)
Sem TicketId
A solicitação de API não tinha um valor ticketId.
400 (Solicitação inválida)
TTL ilegal
A solicitação de API incluiu um valor de TTL não positivo ou não numérico.
400 (Solicitação inválida)
Não foi possível analisar a solicitação.
Problema ao analisar o corpo, como parâmetros incorretos ou valores inválidos.
400 (Solicitação inválida)
Já existe uma janela de manutenção com os mesmos parâmetros.
Aparece quando já existe uma janela de manutenção com os mesmos detalhes.
404 (Não encontrado)
ID do sensor desconhecida
Um dos sensores listados na solicitação não existe.
409 (Conflito)
A ID do tíquete já tem uma janela aberta.
A ID do tíquete está vinculada a outra janela de manutenção aberta.
Recupere um log com todas as ações de abrir (POST), fechar (DELETE) e atualizar (PUT) que foram executadas usando essa API para lidar com janelas de manutenção. T
Filtra os logs da data predefinida em diante. O formato é YYYY-MM-DD.
2022-08-10
Opcional
toDate
Filtra os logs até a data predefinida. O formato é YYYY-MM-DD.
2022-08-10
Opcional
ticketId
Filtra os logs relacionados a uma ID de tíquete específica.
9a5fe99c-d914-4bda-9332-307384fe40bf
Opcional
tokenName
Filtra os logs relacionados a um nome de token específico.
quarterly-sanity-window
Opcional
Códigos de erro:
Código
Mensagem
Descrição
200
OK
A ação foi concluída com êxito.
204:
Sem conteúdo
Não há dados para exibição.
400
Solicitação incorreta
O formato dos dados está incorreto.
500
Erro interno do servidor
Qualquer outro erro inesperado.
Tipo: JSON
Matriz de objetos JSON que representam operações de janelas de manutenção.
Estrutura de resposta:
Nome
Type
Anulável/Não anulável
Lista de valores
id
Long integer
Não permite valor nulo
Uma ID interna para o log atual
dateTime
String
Não permite valor nulo
A hora em que a atividade ocorreu, por exemplo: 2022-04-23T18:25:43.511Z
ticketId
String
Não permite valor nulo
ID da janela de manutenção. Por exemplo: 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName
String
Não permite valor nulo
O nome do token da janela de manutenção. Por exemplo: quarterly-sanity-window
engines
Matriz de cadeia de caracteres
Nullable
Os mecanismos aos quais a janela de manutenção se aplica, conforme indicado durante a criação da janela de manutenção: Protocol Violation, Policy Violation, Malware, Anomaly ou Operational
sensorIds
Matriz de cadeia de caracteres
Nullable
Os sensores aos quais a janela de manutenção se aplica, conforme indicado durante a criação da janela de manutenção.
sub-redes
Matriz de cadeia de caracteres
Nullable
As sub-redes as quais a janela de manutenção se aplica, conforme indicado durante a criação da janela de manutenção.
ttl
Numérico
Nullable
TTL (tempo de vida) da janela de manutenção, conforme fornecido durante a criação ou atualização da janela de manutenção.
Permite atualizar a duração da janela de manutenção depois de iniciar o processo de manutenção alterando o parâmetro ttl. A nova definição de duração substitui a anterior.
Esse método é útil quando você deseja definir uma duração maior do que a duração configurada atualmente. Por exemplo, se você definiu originalmente 180 minutos, 90 minutos se passaram, e você quer adicionar mais 30 minutos, atualize o minuto ttl a 120 para redefinir a contagem de duração.