API : Vue d’ensemble des méthodes de périphérique

Méthodes disponibles

Exemple de connexion

Exemple d’objet JSON ServerView/BrowserView Device

{
    "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"
}

Description des champs

Utilisez ces champs pour spécifier des informations sur un périphérique dans vos demandes d’API.

champ

Type

description

Avoid_Simultaneous_Checks

booléen

Indique si la vérification simultanée à partir des emplacements de surveillance multiples est autorisée. Disponible uniquement pour les équipements ServerView.

exemple:

"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

int32 (en)

LECTURE SEULE. Définit la période en minutes pendant laquelle toutes les alertes sont désactivées. Pour désactiver les alertes, utilisez API : Désactiver les alertes pour l’appareil ou API : Désactiver les alertes pour plusieurs appareils.

exemple:

"Alert_Silence_Min": 46

False_Positive_Check

booléen

Lorsqu’une erreur est détectée, nous effectuons une série de vérifications pour nous assurer qu’il ne s’agit pas d’une fausse alerte. Ces vérifications peuvent prendre un certain temps, selon le type d’erreur et le nombre de tâches dans l’appareil. Cela peut entraîner un certain retard dans l’alerte de temps d’arrêt. Vous pouvez désactiver la vérification des faux positifs (état « vrai ») pour garantir une alerte immédiate de temps d’arrêt, mais cela peut entraîner de « fausses » alertes. Nous vous recommandons de NE PAS désactiver la « Vérification des faux positifs ».

exemple:

"False_Positive_Check": false

Lieux

tableau d’int32

Tableau contenant des ID d’emplacement attribués à un périphérique spécifié. Au moins un emplacement doit être spécifié dans les demandes.

exemple:

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

étiquettes

tableau de chaîne

Tableau contenant les noms des balises affectées à un périphérique spécifié.

exemple:

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

Send_Uptime_Alert

booléen

Lorsque cette option est activée, vous recevez une alerte lorsque toutes les erreurs détectées sont résolues.

exemple:

"Send_Uptime_Alert": false

Status_Description

corde

LECTURE SEULE. Description de l’état actuel de l’appareil.

exemple:

"Status_Description": "POSTPONED"

reporter

booléen

La surveillance peut être mise en pause en reportant un appareil.

exemple:

"Postpone": true,

Owner_Device_Id

int32 (en)

Ce champ reflète l’ID du périphérique propriétaire.

exemple:

"Owner_Device_Id": 8534

Fréquence

int32 (en)

Ce champ reflète la fréquence de surveillance en secondes.

exemple:

"Frequency": 10800

Filter_Id

int32 (en)

Ce champ reflète l’ID de filtre attribué à un périphérique.

exemple:

"Filter_Id": 853

Scheduler_Id

int32 (en)

Ce champ reflète l’ID du planificateur attribué à un périphérique.

exemple:

"Scheduler_Id": 534

Notifications

tableau d’objets

Indique une liste de paramètres d’alerte.

Exemple #1 :

"Notifications":

{

"E_Mail_Flag": true,

"E_Mail_Address": "demo@at.com",

"E_Mail_TimeInterval_Min": 10

}

Exemple #2 :

"Notifications":

{

"Notification_Groups":

[{

"Id": 608,

"Time_Shift_Min": 10

}]

}

E_Mail_Flag

booléen

Définit si une alerte par e-mail sera envoyée.

exemple:

"E_Mail_Flag": false

E_Mail_Address

corde

Spécifie une adresse e-mail pour les alertes par courrier électronique.

exemple:

"E_Mail_Address": "demo@company.com"

E_Mail_TimeInterval_Min

int32 (en)

Ce champ permet de définir un intervalle entre les alertes email en minutes

exemple:

"E_Mail_TimeInterval_Min": 15

WL_Device_Flag

booléen

Définit si une alerte de périphérique sans fil sera envoyée.

exemple:

"WL_Device_Flag": false

WL_Device_Email_Address

corde

Ce champ spécifie un périphérique sans fil, tel qu’un téléphone ou un téléavertisseur, pour les alertes.

exemple:

"WL_Device_Email_Address": "wireless@company.com"

WL_Device_TimeInterval_Min

int32 (en)

Ce champ permet de définir un intervalle entre les alertes de périphérique sans fil en minutes.

exemple:

"WL_Device_TimeInterval_Min": 13

Pager_Flag

booléen

Définit si des alertes de téléavertisseur seront envoyées.

exemple:

"Pager_Flag": true

Pager_Area_Code

corde

Indicatif régional du pager.

exemple:

"Pager_Area_Code": "917"

Pager_Phone

corde

Téléphone pager.

exemple:

"Pager_Phone": "3214564"

Pager_Num_Code

corde

Code pour les pagers numériques.

exemple:

"Pager_Num_Code": "225"

Pager_TimeInterval_Min

int32 (en)

Ce champ permet de définir un intervalle entre les alertes du pager en minutes.

exemple:

"Pager_TimeInterval_Min": 5

Phone_Flag

booléen

Définit si des alertes téléphoniques auront lieu. Pour recevoir des alertes par téléphone, définissez la valeur sur « true » et spécifiez le numéro de téléphone. Les alertes téléphoniques sont interactives, ce qui vous permet de reporter les alertes suivantes une fois qu’une alerte est reçue.

exemple:

"Phone_Flag": true

Phone_Area_Code

corde

Si l’indicatif du pays est « 1 » (par exemple, aux États-Unis, au Canada et dans les Caraïbes), entrez l’indicatif régional et le numéro (par exemple, 952-5134349). Pour tous les autres codes de pays, utilisez le préfixe « 011 », l’indicatif du pays et le numéro de téléphone (par exemple, 011-44-95-2244392).

exemple:

"Phone_Area_Cde": "952"

Phone_Phone

corde

numéro de téléphone.

exemple:

"Phone_Phone": "5134349"

Phone_TimeInterval_Min

int32 (en)

Ce champ permet de définir un intervalle entre les appels téléphoniques.

exemple:

"Phone_TimeInterval_Min": 2

SMS_Flag

booléen

Définit si des alertes SMS seront envoyées.

exemple:

"SMS_Flag": false

SMS_Phone

corde

Un numéro de téléphone avec un code de pays (par exemple: États-Unis – 1 952 513 4349; Royaume-Uni 449524 4392). N’utilisez PAS de préfixe de numérotation internationale, tel que « 011 » dans le numéro.

exemple:

"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

int32 (en)

Ce champ permet de définir un intervalle entre les alertes SMS.

exemple:

"SMS_TimeInterval_Min": 0

Script_Flag

booléen

Ce champ définit si l’alerte sera effectuée par un script d’alerte personnalisé.

exemple:

"Script_Flag": false

Script_Batch_File_Name

corde

Nom de fichier script personnalisé. Le script doit déjà être installé sur le serveur.

exemple:

"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

int32 (en)

Ce champ permet de définir un intervalle entre les alertes de script personnalisées.

exemple:

"Script_TimeInterval_Min":5

Notification_Groups

tableau d’objets

Indique les groupes d’alerte actifs avec leur pièce d’identité et leur décalage horaire. Timeshift est une option qui vous permet de créer un processus d’escalade d’alerte basé sur la durée de la condition d’erreur. Par exemple, le premier groupe de notification peut être notifié immédiatement, le deuxième – après 10 minutes d’indisponibilité et le troisième groupe – après 60 minutes d’indisponibilité. Les intervalles de temps d’escalade d’alerte varient de immédiate à trois heures.

exemple:

"Notification_Groups":

[{

"Id": 608,

"Time_Shift_Min": 10

}, {

"Id": 609,

"Time_Shift_Min": 20

}]

Number_Of_Tasks

int32 (en)

LIRE SEULEMENT Champ. Affiche le nombre de tâches sous le périphérique spécifié.

exemple:

"Number_Of_Tasks": 15

int32 (en)

LIRE SEULEMENT Champ. ID d’appareil unique. Attribué automatiquement lors de la création d’un nouvel appareil. Permet de spécifier un périphérique dans les demandes.

exemple:

"Id": 8533

Platform_Id

int32 (en)

LIRE SEULEMENT Champ. Chaque plateforme (ServerView, UserView, etc.) possède son propre ID. Découvrez comment obtenir les informations d’identifie des plates-formes ici.

exemple:

"Platform_Id": 1

nom

corde

Nom de l’appareil.

exemple:

"Name": "new name"