maintenanceWindow (uitsluitingen voor waarschuwingen maken)
Beheert onderhoudsvensters, waaronder geen waarschuwingen worden verzonden. Gebruik deze API voor het definiëren en bijwerken van stop- en starttijden, apparaten of subnetten die moeten worden uitgesloten bij het activeren van waarschuwingen, of het definiëren en bijwerken van Defender for IoT-engines die moeten worden uitgesloten.
Tijdens een onderhoudsvenster wilt u bijvoorbeeld de levering van waarschuwingen voor alle waarschuwingen stoppen, met uitzondering van malwarewaarschuwingen op kritieke apparaten.
De onderhoudsvensters die met de maintenanceWindow API worden gedefinieerd, worden in het venster Uitsluitingen van waarschuwingen van de on-premises beheerconsole weergegeven als een uitsluitingsregel met het kenmerk Alleen-lezen, met de naam met de volgende syntaxis: Maintenance-{token name}-{ticket ID}.
Belangrijk
Deze API wordt alleen ondersteund voor onderhoudsdoeleinden en voor een beperkte periode en is niet bedoeld om te worden gebruikt in plaats van regels voor het uitsluiten van waarschuwingen. Gebruik deze API alleen voor eenmalige, tijdelijke onderhoudsbewerkingen.
Tekenreeks. Definieert de onderhoudsticket-id in de systemen van de gebruiker. Zorg ervoor dat de ticket-id niet is gekoppeld aan een bestaand geopend venster.
2987345p98234
Vereist
Ttl
Positief geheel getal. Definieert de TTL (time to live), de duur van het onderhoudsvenster, in minuten. Nadat de gedefinieerde periode is voltooid, is het onderhoudsvenster voorbij en gedraagt het systeem zich weer normaal.
180
Vereist
Engines
JSON-matrix met tekenreeksen. Definieert van welke engine waarschuwingen tijdens het onderhoudsvenster moeten worden onderdrukt. Mogelijke waarden:
JSON-matrix met tekenreeksen. Hiermee definieert u vanaf welke sensoren waarschuwingen tijdens het onderhoudsvenster moeten worden onderdrukt. U kunt deze sensor-id's ophalen uit de API voor apparaten (OT-sensorapparaten beheren).
1,35,63
Optioneel
Subnetten
JSON-matrix met tekenreeksen. Definieert de subnetten voor het onderdrukken van waarschuwingen tijdens het onderhoudsvenster. Definieer elk subnet in een CIDR-notatie.
192.168.0.0/16,138.136.80.0/14,112.138.10.0/8
Optioneel
Statuscode
Bericht
Beschrijving
201 (gemaakt)
-
De actie is voltooid.
400 (ongeldige aanvraag)
Geen TicketId
Er ontbreekt een waarde in de ticketId API-aanvraag.
400 (ongeldige aanvraag)
Ongeldige TTL
API-aanvraag bevat een niet-positieve of niet-numerieke TTL-waarde.
400 (ongeldige aanvraag)
Kan aanvraag niet parseren.
Probleem bij het parseren van de hoofdtekst, zoals onjuiste parameters of ongeldige waarden.
400 (ongeldige aanvraag)
Er bestaat al een onderhoudsvenster met dezelfde parameters.
Wordt weergegeven wanneer er al een bestaand onderhoudsvenster bestaat met dezelfde details.
404 (niet gevonden)
Onbekende sensor-id
Een van de sensoren die in de aanvraag worden vermeld, bestaat niet.
409 (Conflict)
Ticket-id heeft al een geopend venster.
De ticket-id is gekoppeld aan een ander geopend onderhoudsvenster.
Haal een logboek op van alle acties voor openen (POST), sluiten (DELETE) en bijwerken (PUT) die met deze API zijn uitgevoerd voor het afhandelen van onderhoudsvensters. T
Filtert de logboeken vanaf de vooraf gedefinieerde datum en hoger. De indeling is YYYY-MM-DD.
2022-08-10
Optioneel
Todate
Filtert de logboeken tot de vooraf gedefinieerde datum. De indeling is YYYY-MM-DD.
2022-08-10
Optioneel
ticketId
Filtert de logboeken met betrekking tot een specifieke ticket-id.
9a5fe99c-d914-4bda-9332-307384fe40bf
Optioneel
tokenName
Filtert de logboeken met betrekking tot een specifieke tokennaam.
kwartaal-sanity-venster
Optioneel
Foutcodes:
Code
Bericht
Beschrijving
200
OK
De actie is voltooid.
204:
Geen inhoud
Er zijn geen gegevens om weer te geven.
400
Onjuiste aanvraag
De datumnotatie is onjuist.
500
Interne serverfout
Eventuele andere onverwachte fouten.
Type: JSON
Matrix van JSON-objecten die onderhoudsvensterbewerkingen vertegenwoordigen.
Antwoordstructuur:
Naam
Type
Nullable /Not nullable
Lijst met waarden
id
Lang geheel getal
Niet nullable
Een interne id voor het huidige logboek
datumTijd
Tekenreeks
Niet nullable
Het tijdstip waarop de activiteit heeft plaatsgevonden, bijvoorbeeld: 2022-04-23T18:25:43.511Z
ticketId
Tekenreeks
Niet nullable
De id van het onderhoudsvenster. Bijvoorbeeld: 9a5fe99c-d914-4bda-9332-307384fe40bf
tokenName
Tekenreeks
Niet nullable
De naam van het token van het onderhoudsvenster. Bijvoorbeeld: quarterly-sanity-window
Engines
Matrix van tekenreeksen
Null-waarde toegestaan
De motoren waarop het onderhoudsvenster van toepassing is, zoals opgegeven tijdens het maken van het onderhoudsvenster: Protocol Violation, Policy Violation, Malware, Anomaly, of Operational
sensorIds
Matrix van tekenreeks
Null-waarde toegestaan
De sensoren waarop het onderhoudsvenster van toepassing is, zoals opgegeven tijdens het maken van onderhoudsvensters.
Subnetten
Matrix van tekenreeks
Null-waarde toegestaan
De subnetten waarop het onderhoudsvenster van toepassing is, zoals opgegeven tijdens het maken van het onderhoudsvenster.
Ttl
Numeriek
Null-waarde toegestaan
De TTL (Time to Live) van het onderhoudsvenster, zoals opgegeven tijdens het maken of bijwerken van onderhoudsvensters.
Hiermee kunt u de duur van het onderhoudsvenster bijwerken nadat u het onderhoudsproces hebt gestart door de ttl parameter te wijzigen. De nieuwe duurdefinitie overschrijft de vorige definitie.
Deze methode is handig als u een langere duur wilt instellen dan de momenteel geconfigureerde duur. Als u bijvoorbeeld oorspronkelijk 180 minuten hebt gedefinieerd, er 90 minuten zijn verstreken en u nog eens 30 minuten wilt toevoegen, werkt u de ttl naar minuut bij om het aantal duur opnieuw in te 120 stellen.