Verfügbare Methoden

Verbindungsbeispiel

JSON-Beispiel für ein ServerView/BrowserView-Gerät
{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": 28,
    "False_Positive_Check": false,
    "Locations": [
        1,
        4,
        6,
        14,
        15,
        17,
        19,
        23,
        43,
        71,
        73
    ],
    "Tags": [
        "my_device"
    ],
    "ContextParams": [],
    "Send_Uptime_Alert": false,
    "Status_Description": "POSTPONED",
    "Postpone": true,
    "Owner_Device_Id": 0,
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Scheduler_Id": 0,
    "Notifications": {
        "E_Mail_Flag": false,
        "E_Mail_Address": null,
        "E_Mail_TimeInterval_Min": 0,
        "WL_Device_Flag": false,
        "WL_Device_Email_Address": null,
        "WL_Device_TimeInterval_Min": 0,
        "Pager_Flag": false,
        "Pager_Area_Code": null,
        "Pager_Phone": null,
        "Pager_Num_Code": null,
        "Pager_TimeInterval_Min": 0,
        "Phone_Flag": false,
        "Phone_Area_Code": null,
        "Phone_Phone": null,
        "Phone_TimeInterval_Min": 0,
        "SMS_Flag": false,
        "SMS_Phone": null,
        "SMS_TimeInterval_Min": 0,
        "Script_Flag": false,
        "Script_Batch_File_Name": null,
        "Script_TimeInterval_Min": 0,
        "SNMP_TimeInterval_Min": 0,
        "Teams_TimeInterval_Min": 0,
        "Slack_TimeInterval_Min": 0,
        "AlertOps_TimeInterval_Min": 0,
        "PagerDuty_TimeInterval_Min": 0,
        "Notification_Groups": []
    },
    "Id": 47432,
    "Number_Of_Tasks": 1,
    "WaitingForApproval": false,
    "Platform_Id": 1,
    "Package_Id": 52,
    "Name": "FullPageDomain.cs"
}

Beschreibung der Felder

Verwenden Sie diese Felder, um Informationen zu einem Gerät in Ihren API-Anforderungen anzugeben.

Feld

drucktype

 beschreibung

Avoid_Simultaneous_Checks

boolesch

 Gibt an, ob die gleichzeitige Überprüfung von mehreren Überwachungsstandorten zulässig ist. Nur für ServerView-Geräte verfügbar.

Beispiel:
"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

int32

 SCHREIBGESCHÜTZT. Definiert den Zeitraum in Minuten, in dem alle Warnungen deaktiviert sind. Um Warnungen zu deaktivieren, verwenden Sie API: Warnungen für Gerät deaktivieren oder API: Warnungen für mehrere Geräte deaktivieren.

Beispiel:
"Alert_Silence_Min": 46

False_Positive_Check

boolesch

 Wenn ein Fehler erkannt wird, führen wir eine Reihe von Überprüfungen durch, um sicherzustellen, dass es sich nicht um einen Fehlalarm handelt. Diese Prüfungen können je nach Fehlertyp und Anzahl der Aufgaben im Gerät einige Zeit in Anspruch nehmen. Dies kann zu einer gewissen Verzögerung bei der Ausfallwarnung führen. Sie können die False-Positive-Prüfung (“true”-Status) deaktivieren, um eine sofortige Ausfallwarnung zu gewährleisten, dies kann jedoch zu einigen “falschen” Warnungen führen. Wir empfehlen, die “False-Positive-Prüfung” NICHT zu deaktivieren.

Beispiel:
"False_Positive_Check": false

Standorte

Array von int32

 Ein Array mit Standort-IDs, die einem bestimmten Gerät zugewiesen sind. In den Anforderungen muss mindestens ein Speicherort angegeben werden.

Beispiel:
"Locations": [1, 2, 4, 5, 8]

Schilder

Array der Zeichenfolge

 Ein Array, das die Namen der Tags enthält, die einem bestimmten Gerät zugewiesen sind.

Beispiel:
"Tags": ["green", "red", "black"]

Send_Uptime_Alert

boolesch

 Wenn diese Option aktiviert ist, erhalten Sie eine Warnung, wenn alle erkannten Fehler behoben werden.

Beispiel:
"Send_Uptime_Alert": false

Status_Description

Schnur

 SCHREIBGESCHÜTZT. Beschreibung des aktuellen Gerätezustands.

Beispiel:
"Status_Description": "POSTPONED"

Verschieben

boolesch

 Die Überwachung kann durch Verschieben eines Geräts pausiert werden.

Beispiel:
"Postpone": true,

Owner_Device_Id

int32

 Dieses Feld gibt die Geräte-ID des Besitzers an.

Beispiel:
"Owner_Device_Id": 8534

Frequenz

int32

 Dieses Feld spiegelt die Überwachungsfrequenz in Sekunden wider.

Beispiel:
"Frequency": 10800

Filter_Id

int32

 Dieses Feld spiegelt die Filter-ID wider, die einem Gerät zugewiesen ist.

Beispiel:
"Filter_Id": 853

Scheduler_Id

int32

 Dieses Feld gibt die Scheduler-ID an, die einem Gerät zugewiesen ist.

Beispiel:
"Scheduler_Id": 534

Benachrichtigungen

Array von Objekten

 Gibt eine Liste der Warnungseinstellungen an.

Beispiel #1:
"Notifications":
{
"E_Mail_Flag": true,
"E_Mail_Address": "demo@at.com",
"E_Mail_TimeInterval_Min": 10
}
Beispiel #2:
"Notifications":
{
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}]
}

E_Mail_Flag

boolesch

 Legt fest, ob eine E-Mail-Benachrichtigung gesendet wird.

Beispiel:
"E_Mail_Flag": false

E_Mail_Address

Schnur

 Gibt eine E-Mail-Adresse für E-Mail-Benachrichtigungen an.

Beispiel:
"E_Mail_Address": "demo@company.com"

E_Mail_TimeInterval_Min

int32

 In diesem Feld können Sie ein Intervall zwischen E-Mail-Benachrichtigungen in Minuten festlegen

Beispiel:
"E_Mail_TimeInterval_Min": 15

WL_Device_Flag

boolesch

 Legt fest, ob eine Warnung für drahtlose Geräte gesendet wird.

Beispiel:
"WL_Device_Flag": false

WL_Device_Email_Address

Schnur

 Dieses Feld gibt ein drahtloses Gerät, z. B. ein Telefon oder einen Pager, für Warnungen an.

Beispiel:
"WL_Device_Email_Address": "wireless@company.com"

WL_Device_TimeInterval_Min

int32

 In diesem Feld können Sie ein Intervall zwischen Warnungen für drahtlose Geräte in Minuten festlegen.

Beispiel:
"WL_Device_TimeInterval_Min": 13

Pager_Flag

boolesch

 Definiert, ob Pagerwarnungen gesendet werden.

Beispiel:
"Pager_Flag": true

Pager_Area_Code

Schnur

 Pager-Vorwahl.

Beispiel:
"Pager_Area_Code": "917"

Pager_Phone

Schnur

 Pager Telefon.

Beispiel:
"Pager_Phone": "3214564"

Pager_Num_Code

Schnur

 Code für numerische Pager.

Beispiel:
"Pager_Num_Code": "225"

Pager_TimeInterval_Min

int32

 Dieses Feld ermöglicht das Festlegen eines Intervalls zwischen Pagerwarnungen in Minuten.

Beispiel:
"Pager_TimeInterval_Min": 5

Phone_Flag

boolesch

 Definiert, ob Telefonanrufwarnungen stattfinden. Um Benachrichtigungen per Telefon zu erhalten, setzen Sie den Wert auf “true” und geben Sie die Telefonnummer an. Telefonische Benachrichtigungen sind interaktiv, sodass Sie nachfolgende Warnungen verschieben können, sobald eine Warnung eingegangen ist.

Beispiel:
"Phone_Flag": true

Phone_Area_Code

Schnur

 Wenn die Landesvorwahl “1” lautet (z. B. in den USA, Kanada und der Karibik), geben Sie die Ortsvorwahl und die Nummer ein (z. B. 952-5134349). Verwenden Sie für alle anderen Ländervorwahlen die Vorwahl “011”, die Landesvorwahl und die Telefonnummer (z. B. 011-44-95-2244392).

Beispiel:
"Phone_Area_Cde": "952"

Phone_Phone

Schnur

 Telefonnummer.

Beispiel:
"Phone_Phone": "5134349"

Phone_TimeInterval_Min

int32

 Dieses Feld ermöglicht das Festlegen eines Intervalls zwischen Telefonanrufen.

Beispiel:
"Phone_TimeInterval_Min": 2

SMS_Flag

boolesch

 Definiert, ob SMS-Benachrichtigungen gesendet werden.

Beispiel:
"SMS_Flag": false

SMS_Phone

 Schnur Eine Telefonnummer mit einer Ländervorwahl (z. B. US – 1 952 513 4349; 449524 4392). Verwenden Sie KEINE internationale Vorwahl, z. B. “011” in der Nummer.

Beispiel:
"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

int32

 Dieses Feld ermöglicht das Festlegen eines Intervalls zwischen SMS-Warnungen.

Beispiel:
"SMS_TimeInterval_Min": 0

Script_Flag

boolesch

 Dieses Feld definiert, ob die Warnung von einem benutzerdefinierten Warnungsskript ausgeführt wird.

Beispiel:
"Script_Flag": false

Script_Batch_File_Name

Schnur

 Benutzerdefinierter Skript-Dateiname. Das Skript muss bereits auf dem Server installiert sein.

Beispiel:
"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

int32

 Dieses Feld ermöglicht das Festlegen eines Intervalls zwischen benutzerdefinierten Skriptwarnungen.

Beispiel:
"Script_TimeInterval_Min":5

Notification_Groups

Array von Objekten

 Gibt aktive Warnungsgruppen mit ihrer ID und Zeitverschiebung an. Timeshift ist eine Option, mit der Sie einen Warnungseskalationsprozess erstellen können, der auf der Dauer der Fehlerbedingung basiert, z. B. kann die erste Benachrichtigungsgruppe sofort, die zweite nach 10 Minuten Ausfallzeit und die dritte Gruppe nach 60 Minuten Ausfallzeit benachrichtigt werden. Die Zeitintervalle der Warnungseskalation reichen von unmittelbar bis drei Stunden.

Beispiel:
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}, {
"Id": 609,
"Time_Shift_Min": 20
}]

Number_Of_Tasks

int32

 LESEN Sie NUR Feld. Zeigt die Anzahl der Aufgaben unter dem angegebenen Gerät an.

Beispiel:
"Number_Of_Tasks": 15

Id

int32

 LESEN Sie NUR Feld. Die eindeutige Geräte-ID. Wird automatisch bei der Erstellung eines neuen Geräts zugewiesen. Wird verwendet, um ein Gerät in Anforderungen anzugeben.

Beispiel:
"Id": 8533

Platform_Id

int32

 LESEN Sie NUR Feld. Jede Plattform (ServerView, UserView usw.) hat ihre eigene ID. Hier erfahren Sie, wie Sie die IDs der Plattformen erhalten.

Beispiel:
"Platform_Id": 1

name

Schnur

 Der Name des Geräts.

Beispiel:
"Name": "new name"