Gestion des alarmes Ouvrir l’API
L’API ouverte de gestion des alarmes fournit des points de terminaison pour créer, mettre à jour et récupérer des données à partir des tables d’événements [em_event] et d’alerte [em_alert].
L’API ouverte de gestion des alarmes de télécommunications (sn_ind_tmf642) est une ServiceNow® implémentation de la spécification de l’API ouverte TM Forum. Cette API est basée sur la spécification REST de l’API TMF642 Alarm Management REST Specification Version 20, avril 2020.
L’utilisateur appelant doit avoir accès au point de terminaison sn_ind_tmf642.alarm_mgmt_integration .
Cette API est fournie dans l’espace de noms sn_ind_tmf642 .
La spécification de l’API ouverte TM Forum exige une réponse synchrone pour chaque demande entrante qu’elle reçoit. Appliquez la corrélation et la déduplication dans le système de support opérationnel (OSS) source avant de transmettre les charges utiles au système.
Cette API peut être étendue pour effectuer des personnalisations autour des paramètres requis, de la validation du corps de la demande, des opérations REST supplémentaires et des mappages de champs. Pour plus d'informations, voir le Guide du développeur de l’API ouverte de gestion des alarmes.
L’API ouverte de gestion des alarmes est certifiée conforme par TM Forum.
Gestion des alarmes API ouverte – GET /sn_ind_tmf642/alarm_mgmt/alarm
Récupère une liste de tous les enregistrements d’alarme à partir des tables Événements [em_event] et Alerte [em_alert].
Format d'URL
URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| alarmRaisedTime | Date à laquelle l’alarme a été déclenchée. Seules les alarmes dont la date correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides :
Par défaut : Tous les champs Type de données : chaîne |
| id | ID d’alarme. Seules les alarmes avec un ID correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Situé dans le champ Clé du message de la table Événements [em_event]. Type de données : chaîne |
| limite | Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement offset . Par défaut : 1 000 Maximum : 2000 Type de données : nombre |
| décalage | Index de départ auquel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par défaut : 0 Type de données : nombre |
| Cause probable | Cause probable de l’alarme. Seules les alarmes dont la cause probable correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| État | État de l’alarme. Seules les alarmes dont l’état correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| sourceSystemId (en anglais seulement) | ID du système source de l’alarme. Seules les alarmes avec un ID système source correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Aucun |
| En-tête | Description |
|---|---|
| Plage de contenu | Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si |
| Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . |
| Lien | Contient les liens suivants pour parcourir les résultats de la requête.
|
| X-Total-Count | Pour les requêtes paginées, cet en-tête indique le nombre total d’enregistrements disponibles sur le serveur. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination). |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Raisons possibles :
|
| 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| service affecté | Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau |
| serviceaffecté.href | Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne |
| affectedService.id | Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne |
| alarmDetails (en anglais seulement) | Détails supplémentaires sur l’alarme. Type de données : chaîne |
| alarmedObject | Détails de l’objet d’alarme. Type de données : objet |
| alarmedObject.id | Identificateur unique de l’objet d’alarme. Cette valeur est mappée à un CI dans le système. Type de données : chaîne |
| alarmedObject.href | Référence URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne |
| alarmdObjectType | Type ou classe d’objet associé à l’événement. Type de données : chaîne |
| alarmRaisedTime | Date et heure auxquelles l’alarme se produit à sa source. Type de données : chaîne |
| alarmReportingTime | Date et heure auxquelles l’OSS signale son alarme. Cette valeur peut différer de la alarmRaisedTime valeur. Par exemple, si un système de gestion des éléments (EMS) tient à jour la liste d’alarmes :
Type de données : chaîne |
| Type d’alarme | Catégorie d’alarme. Type de données : chaîne |
| informationsSeuils croisés | Détails sur le seuil franchi.Type de données : objet |
| informationssSeuils croisés.direction | Direction du franchissement du seuil. Valeurs possibles :
Type de données : chaîne |
| informationThresholdInformation.granularité croisée | Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, 5MINUTES.Type de données : chaîne |
| crossedThresholdInformation.indicatorName | Nom de l’indicateur qui franchit le seuil d’alarme. Type de données : chaîne |
| CrossedThresholdInformation.indicatorUnit | Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne |
| informationThresholdInformation.observedValue | Numéro identifiant l’indicateur dépassant le seuil. Type de données : chaîne |
| informationThresholdInformation.thresholdCrossingDescription | Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne |
| CrossedThresholdInformation.thresholdId | Identificateur unique du seuil qui a provoqué l’alarme. Type de données : chaîne |
| informationThresholdInformation.thresholdRef croisée | URL de l’objet de seuil. Type de données : chaîne |
| ID d’alarme externe | Identificateur unique de l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne |
| href | URL de la ressource. Type de données : chaîne |
| id | Identificateur unique permettant au système d’identifier et de traiter la charge utile de l’alarme en tant qu’événement. Type de données : chaîne |
| perceivedSeverity | Gravité de l’alarme. Valeurs possibles :
Type de données : chaîne |
| plannedOutageIndication | Indique que l’objet géré pour cette alarme est dans un état de panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne |
| Cause probable | Situation la plus probable pour déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne |
| Actions de réparation proposées | Si disponible, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne |
| serviceAffectant | Marqueur indiquant si l’alarme affecte le service. Valeurs valides :
Valeur par défaut : false Type de données : booléennes |
| sourceSystemId (en anglais seulement) | ID d’instance de la source d’alarme. Type de données : chaîne |
| Problème spécifique | Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne |
| État | État de l’alarme. Valeurs valides :
Prêt.Si l’état est Valeur par défaut : prêt Type de données : chaîne |
Demande cURL
Cet exemple récupère toutes les alarmes.
curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corps de réponse.
[
{
"externalAlarmId": "2212331",
"alarmType": "QualityOfServiceAlarm23",
"perceivedSeverity": "MAJOR",
"probableCause": "ProbB",
"sourceSystemId": "checkSB",
"alarmedObject": {
"id": "vManage_000000",
"href": " http://api/alarmedobject/000000"
},
"crossedThresholdInformation": {
"direction": "111",
"granularity": "1234",
"indicatorName": "sdfgds",
"indicatorUnit": "asdfdsaf",
"observedValue": "adsfds",
"thresholdId": "12fasdfasdfasd",
"thresholdCrossingDescription": "S23rtring",
"thresholdRef": "asdfasf"
},
"type": "QualityOfServiceAlarm",
"ackState": "acknowledged",
"specificProblem": "Inbound Traffic threshold crossed",
"alarmedObjectType": "ROUTER",
"alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
"state": "processed",
"alarmChangedTime": "2017-08-15T07:04:15.666Z",
"proposedRepairActions": "Switch in standby equipment",
"alarmReportingTime": "2017-06-15T07:04:15.666Z",
"alarmRaisedTime": "2020-09-15T14:04:15.000Z",
"plannedOutageIndication": "IN_SERVICE",
"serviceAffecting": true,
"affectedService": [
{
"id": "SD WAN Enterprise Solutions",
"href": "http://api/service/vlan_dot0_dot0"
},
{
"id": "Santa Clara SD WAN Application Service",
"href": "http://api/service/vlan_dot0_dot0"
}
],
"source": "Alarm Management Open API",
"href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
"id": "001a0ca629078d10f87759e2f69e4c64_2212331"
},
{
"externalAlarmId": "2212331",
"alarmType": "QualityOfServiceAlarm23",
"perceivedSeverity": "MAJOR",
"probableCause": "ProbB",
"sourceSystemId": "checkSB",
"alarmedObject": {
"id": "vManage_000000",
"href": " http://api/alarmedobject/000000"
},
"crossedThresholdInformation": {
"direction": "111",
"granularity": "1234",
"indicatorName": "sdfgds",
"indicatorUnit": "asdfdsaf",
"observedValue": "adsfds",
"thresholdId": "12fasdfasdfasd",
"thresholdCrossingDescription": "S23rtring",
"thresholdRef": "asdfasf"
},
"type": "QualityOfServiceAlarm",
"ackState": "acknowledged",
"specificProblem": "Inbound Traffic threshold crossed",
"alarmedObjectType": "ROUTER",
"alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
"state": "processed",
"alarmChangedTime": "2017-08-15T07:04:15.666Z",
"proposedRepairActions": "Switch in standby equipment",
"alarmReportingTime": "2017-06-15T07:04:15.666Z",
"alarmRaisedTime": "2020-09-15T14:04:15.000Z",
"plannedOutageIndication": "IN_SERVICE",
"serviceAffecting": true,
"affectedService": [
{
"id": "SD WAN Enterprise Solutions",
"href": "http://api/service/vlan_dot0_dot0"
},
{
"id": "Santa Clara SD WAN Application Service",
"href": "http://api/service/vlan_dot0_dot0"
}
],
"source": "Alarm Management Open API",
"href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001c84aa29078d10f87759e2f69e4cfa_2212331",
"id": "001c84aa29078d10f87759e2f69e4cfa_2212331"
}
]Gestion des alarmes API ouverte – GET /sn_ind_tmf642/alarm_mgmt/alarm/{id}
Récupère un enregistrement d’alarme spécifié à partir de la table Événements [em_event] ou Alerte [em_alert].
Format d'URL
URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Identificateur unique de l’enregistrement à récupérer. Situé dans le champ Clé du message de la table Événements [em_event]. Type de données : chaîne |
| Nom | Description |
|---|---|
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides :
Valeur par défaut : Tous les champs Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté pour une ou plusieurs des raisons suivantes.
|
| 404 | Enregistrement introuvable. Un enregistrement associé à l’ID spécifié n’a pas été trouvé dans la table Événement [em_event] ou Alerte [em_alert]. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| service affecté | Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau |
| serviceaffecté.href | Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne |
| affectedService.id | Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne |
| alarmDetails (en anglais seulement) | Détails supplémentaires sur l’alarme. Type de données : chaîne |
| alarmedObject | Détails de l’objet d’alarme. Type de données : objet |
| alarmedObject.id | Identificateur unique de l’objet d’alarme. Cette valeur est mappée à un CI dans le système. Type de données : chaîne |
| alarmedObject.href | Référence URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne |
| alarmdObjectType | Type ou classe d’objet associé à l’événement. Type de données : chaîne |
| alarmRaisedTime | Date et heure auxquelles l’alarme se produit à sa source. Type de données : chaîne |
| alarmReportingTime | Date et heure auxquelles l’OSS signale son alarme. Cette valeur peut différer de la alarmRaisedTime valeur. Par exemple, si un système de gestion des éléments (EMS) tient à jour la liste d’alarmes :
Type de données : chaîne |
| Type d’alarme | Catégorie d’alarme. Type de données : chaîne |
| informationsSeuils croisés | Détails sur le seuil franchi.Type de données : objet |
| informationssSeuils croisés.direction | Direction du franchissement du seuil. Valeurs possibles :
Type de données : chaîne |
| informationThresholdInformation.granularité croisée | Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, 5MINUTES.Type de données : chaîne |
| crossedThresholdInformation.indicatorName | Nom de l’indicateur qui franchit le seuil d’alarme. Type de données : chaîne |
| CrossedThresholdInformation.indicatorUnit | Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne |
| informationThresholdInformation.observedValue | Numéro identifiant l’indicateur dépassant le seuil. Type de données : chaîne |
| informationThresholdInformation.thresholdCrossingDescription | Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne |
| CrossedThresholdInformation.thresholdId | Identificateur unique du seuil qui a provoqué l’alarme. Type de données : chaîne |
| informationThresholdInformation.thresholdRef croisée | URL de l’objet de seuil. Type de données : chaîne |
| ID d’alarme externe | Identificateur unique de l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne |
| href | URL de la ressource. Type de données : chaîne |
| id | Identificateur unique permettant au système d’identifier et de traiter la charge utile de l’alarme en tant qu’événement. Type de données : chaîne |
| perceivedSeverity | Gravité de l’alarme. Valeurs possibles :
Type de données : chaîne |
| plannedOutageIndication | Indique que l’objet géré pour cette alarme est dans un état de panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne |
| Cause probable | Situation la plus probable pour déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne |
| Actions de réparation proposées | Si disponible, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne |
| serviceAffectant | Marqueur indiquant si l’alarme affecte le service. Valeurs valides :
Valeur par défaut : false Type de données : booléennes |
| sourceSystemId (en anglais seulement) | ID d’instance de la source d’alarme. Type de données : chaîne |
| Problème spécifique | Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne |
| État | État de l’alarme. Valeurs valides :
Prêt.Si l’état est Valeur par défaut : prêt Type de données : chaîne |
Demande cURL
Cet exemple récupère une alarme.
curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Corps de réponse.
{
"externalAlarmId": "2212331",
"alarmType": "QualityOfServiceAlarm23",
"perceivedSeverity": "MAJOR",
"probableCause": "ProbB",
"sourceSystemId": "checkSB",
"alarmedObject": {
"id": "vManage_000000",
"href": " http://api/alarmedobject/000000"
},
"crossedThresholdInformation": {
"direction": "111",
"granularity": "1234",
"indicatorName": "ind_name",
"indicatorUnit": "ind_unit",
"observedValue": "232",
"thresholdId": "200",
"thresholdCrossingDescription": "sample_description",
"thresholdRef": "sample_ref"
},
"type": "QualityOfServiceAlarm",
"ackState": "acknowledged",
"specificProblem": "Inbound Traffic threshold crossed",
"alarmedObjectType": "ROUTER",
"alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
"state": "processed",
"alarmChangedTime": "2017-08-15T07:04:15.666Z",
"proposedRepairActions": "Switch in standby equipment",
"alarmReportingTime": "2017-06-15T07:04:15.666Z",
"alarmRaisedTime": "2020-09-15T14:04:15.000Z",
"plannedOutageIndication": "IN_SERVICE",
"serviceAffecting": true,
"affectedService": [
{
"id": "SD WAN Enterprise Solutions",
"href": "http://api/service/vlan_dot0_dot0"
},
{
"id": "Santa Clara SD WAN Application Service",
"href": "http://api/service/vlan_dot0_dot0"
}
],
"source": "Alarm Management Open API",
"href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
"id": "001a0ca629078d10f87759e2f69e4c64_2212331"
}API ouverte de gestion des alarmes – PATCH /sn_ind_tmf642/alarm_mgmt/alarm/{id}
Met à jour une alarme spécifiée et toute alerte associée.
Ce point de terminaison écrit le corps de la réponse dans le champ Informations supplémentaires de l’enregistrement d’événement dans la table Événements [em_event].
Format d'URL
URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Identificateur unique de l’enregistrement à mettre à jour. Situé dans le champ Clé du message de la table Événements [em_event]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| service affecté | Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau |
| serviceaffecté.href | Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne |
| affectedService.id | Requis. Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne |
| alarmChangedTime | Indique la date et l’heure du dernier changement de l’alarme sur le système propriétaire de l’alarme. Toute modification de l’alarme met à jour cette valeur, qu’elle provienne de la ressource alarmée ou qu’elle soit déclenchée par un changement du client. Type de données : chaîne |
| alarmDetails (en anglais seulement) | Détails supplémentaires sur l’alarme. Type de données : chaîne |
| alarmEscalation | Marqueur indiquant une escalade de la gravité de l’alarme. Valeurs valides :
Valeur par défaut : false Type de données : booléennes |
| informationsSeuils croisés | Détails sur le seuil franchi.Type de données : objet |
| informationssSeuils croisés.direction | Direction du franchissement du seuil. Valeurs possibles :
Type de données : chaîne |
| informationThresholdInformation.granularité croisée | Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, 5MINUTES.Type de données : chaîne |
| crossedThresholdInformation.indicatorName | Nom de l’indicateur qui franchit le seuil d’alarme. Type de données : chaîne |
| CrossedThresholdInformation.indicatorUnit | Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne |
| informationThresholdInformation.observedValue | Numéro identifiant l’indicateur dépassant le seuil. Type de données : chaîne |
| informationThresholdInformation.thresholdCrossingDescription | Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne |
| CrossedThresholdInformation.thresholdId | Requis. Identificateur unique du seuil qui a provoqué l’alarme. Type de données : chaîne |
| informationThresholdInformation.thresholdRef croisée | URL de l’objet de seuil. Type de données : chaîne |
| href | Référence de l’URL à l’alarme. Type de données : chaîne |
| perceivedSeverity | Requis. Gravité de l’alarme. Valeurs possibles :
Type de données : chaîne |
| plannedOutageIndication | Indique que l’objet géré pour cette alarme est dans un état de panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne |
| Cause probable | Requis. Situation la plus probable pour déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne |
| Actions de réparation proposées | Si disponible, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne |
| serviceAffectant | Marqueur indiquant si l’alarme affecte le service. Valeurs valides :
Valeur par défaut : false Type de données : booléennes |
| Problème spécifique | Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Raisons possibles :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| alarmChangedTime | Date et heure auxquelles l’alarme a changé en GMT sur le système propriétaire de l’alarme. Cette valeur est au format GlideDateTime et se trouve dans le Time of event champ d’un enregistrement dans la table Événements [em_events]. Cette valeur est mise à jour lorsque des changements apportés à l’alarme à partir de la ressource alarmée se produisent ou qu’un changement à partir d’une mise à jour du client déclenche l’alarme. Cette valeur est requise dans la réponse. Type de données : chaîne |
| href | Référence de l’URL à l’alarme. Type de données : chaîne |
| id | Identificateur unique de l’alarme. Valeur déterminée par le système propriétaire de l’alarme. Type de données : chaîne |
Demande cURL
Dans cet exemple, la sévérité est réduite à MINEURE.
curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"href\":\"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00\",
\"externalAlarmId\":\"<external-alarm-id>\",
\"alarmType\":\"QualityOfServiceAlarm\",
\"type\":\"QualityOfServiceAlarm\",
\"ackState\":\"acknowledged\",
\"perceivedSeverity\":\"MINOR\",
\"probableCause\":\"Threshold crossed\",
\"specificProblem\":\"Inbound Traffic threshold crossed\",
\"alarmedObjectType\":\"ROUTER\",
\"alarmedObject\":{
\"id\":\"vManage_000000\",
\"href\":\" http://api/alarmedobject/000000\"
},
\"sourceSystemId\":\"SOURCE_SYSTEM_vManage_00000_000_00\",
\"alarmDetails\":\"Software Failure on SD-WAN Controller vManage_000000\",
\"alarmEscalation\": false,
\"state\":\"RAISED\",
\"alarmChangedTime\":\"2017-08-15T07:04:15.666Z\",
\"proposedRepairActions\":\"Switch in standby equipment\",
\"alarmReportingTime\":\"2017-06-15T07:04:15.666Z\",
\"alarmRaisedTime\":\"2020-09-15T07:04:15.666Z\",
\"plannedOutageIndication\":\"IN_SERVICE\",
\"serviceAffecting\":true,
\"affectedService\":[
{
\"id\":\"SD WAN Enterprise Solutions\",
\"href\":\"http://api/service/vlan_dot0_dot0\"
},
{
\"id\":\"Santa Clara SD WAN Application Service\",
\"href\":\"http://api/service/vlan_dot0_dot0\"
}
]
}" \
--user 'user:'password'Corps de réponse.
{
"result": {
"alarmChangedTime": "2017-08-15T07:04:15.666Z",
"id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
}
}Gestion des alarmes API ouverte – POST /sn_ind_tmf642/alarm_mgmt/alarm
Crée un enregistrement d’alarme dans la table Événements [em_event].
Lorsque l’enregistrement d’alarme est créé, un ID pour l’alarme est ajouté dans le Message key champ.
Un enregistrement d’alerte peut également être créé en fonction des règles de gestion des alertes.
Ce point de terminaison écrit le corps de la réponse dans le champ Informations supplémentaires de l’enregistrement d’événement dans la table Événements [em_event].
Format d'URL
URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| service affecté | Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau |
| serviceaffecté.href | Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne |
| affectedService.id | Requis. Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne |
| alarmDetails (en anglais seulement) | Détails supplémentaires sur l’alarme. Type de données : chaîne |
| alarmedObject | Requis. Détails de l’objet d’alarme. Type de données : objet |
| alarmedObject.id | Requis. Identificateur unique de l’objet d’alarme. Cette valeur est mappée à un CI dans le système. Type de données : chaîne |
| alarmedObject.href | Référence URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne |
| alarmdObjectType | Type ou classe d’objet associé à l’événement. Type de données : chaîne |
| alarmRaisedTime | Date et heure auxquelles l’alarme se produit à sa source. Type de données : chaîne |
| alarmReportingTime | Date et heure auxquelles l’OSS signale son alarme. Cette valeur peut différer de la alarmRaisedTime valeur. Par exemple, si un système de gestion des éléments (EMS) tient à jour la liste d’alarmes :
Type de données : chaîne |
| Type d’alarme | Requis. Catégorie d’alarme. Type de données : chaîne |
| informationsSeuils croisés | Détails sur le seuil franchi.Type de données : objet |
| informationssSeuils croisés.direction | Direction du franchissement du seuil. Valeurs possibles :
Type de données : chaîne |
| informationThresholdInformation.granularité croisée | Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, 5MINUTES.Type de données : chaîne |
| crossedThresholdInformation.indicatorName | Nom de l’indicateur qui franchit le seuil d’alarme. Type de données : chaîne |
| CrossedThresholdInformation.indicatorUnit | Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne |
| informationThresholdInformation.observedValue | Numéro identifiant l’indicateur dépassant le seuil. Type de données : chaîne |
| informationThresholdInformation.thresholdCrossingDescription | Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne |
| CrossedThresholdInformation.thresholdId | Requis. Identificateur unique du seuil qui a provoqué l’alarme. Type de données : chaîne |
| informationThresholdInformation.thresholdRef croisée | URL de l’objet de seuil. Type de données : chaîne |
| ID d’alarme externe | Requis. Identificateur unique de l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne |
| id | Identificateur unique permettant au système d’identifier et de traiter la charge utile de l’alarme en tant qu’événement. Cette valeur doit être vide si elle est utilisée dans la charge utile. Le système génère cet ID unique pour l’événement et l’envoie dans le cadre de la charge utile de réponse. Type de données : chaîne |
| perceivedSeverity | Requis. Gravité de l’alarme. Valeurs possibles :
Type de données : chaîne |
| plannedOutageIndication | Indique que l’objet géré pour cette alarme est dans un état de panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne |
| Cause probable | Requis. Situation la plus probable pour déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne |
| Actions de réparation proposées | Si disponible, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne |
| serviceAffectant | Marqueur indiquant si l’alarme affecte le service. Valeurs valides :
Valeur par défaut : false Type de données : booléennes |
| sourceSystemId (en anglais seulement) | Requis. ID d’instance de la source d’alarme. Type de données : chaîne |
| Problème spécifique | Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne |
| État | État de l’alarme. Valeurs valides :
Prêt.Si l’état est Valeur par défaut : prêt Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Raisons possibles :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| service affecté | Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau |
| serviceaffecté.href | Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne |
| affectedService.id | Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne |
| alarmDetails (en anglais seulement) | Détails supplémentaires sur l’alarme. Type de données : chaîne |
| alarmedObject | Détails de l’objet d’alarme. Type de données : objet |
| alarmedObject.id | Identificateur unique de l’objet d’alarme. Cette valeur est mappée à un CI dans le système. Type de données : chaîne |
| alarmedObject.href | Référence URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne |
| alarmdObjectType | Type ou classe d’objet associé à l’événement. Type de données : chaîne |
| alarmRaisedTime | Date et heure auxquelles l’alarme se produit à sa source. Type de données : chaîne |
| alarmReportingTime | Date et heure auxquelles l’OSS signale son alarme. Cette valeur peut différer de la alarmRaisedTime valeur. Par exemple, si un système de gestion des éléments (EMS) tient à jour la liste d’alarmes :
Type de données : chaîne |
| Type d’alarme | Catégorie d’alarme. Type de données : chaîne |
| informationsSeuils croisés | Détails sur le seuil franchi.Type de données : objet |
| informationssSeuils croisés.direction | Direction du franchissement du seuil. Valeurs possibles :
Type de données : chaîne |
| informationThresholdInformation.granularité croisée | Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, 5MINUTES.Type de données : chaîne |
| crossedThresholdInformation.indicatorName | Nom de l’indicateur qui franchit le seuil d’alarme. Type de données : chaîne |
| CrossedThresholdInformation.indicatorUnit | Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne |
| informationThresholdInformation.observedValue | Numéro identifiant l’indicateur dépassant le seuil. Type de données : chaîne |
| informationThresholdInformation.thresholdCrossingDescription | Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne |
| CrossedThresholdInformation.thresholdId | Identificateur unique du seuil qui a provoqué l’alarme. Type de données : chaîne |
| informationThresholdInformation.thresholdRef croisée | URL de l’objet de seuil. Type de données : chaîne |
| ID d’alarme externe | Identificateur unique de l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne |
| href | URL de la ressource. Type de données : chaîne |
| id | Identificateur unique permettant au système d’identifier et de traiter la charge utile de l’alarme en tant qu’événement. Type de données : chaîne |
| perceivedSeverity | Gravité de l’alarme. Valeurs possibles :
Type de données : chaîne |
| plannedOutageIndication | Indique que l’objet géré pour cette alarme est dans un état de panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne |
| Cause probable | Situation la plus probable pour déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne |
| Actions de réparation proposées | Si disponible, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne |
| serviceAffectant | Marqueur indiquant si l’alarme affecte le service. Valeurs valides :
Valeur par défaut : false Type de données : booléennes |
| sourceSystemId (en anglais seulement) | ID d’instance de la source d’alarme. Type de données : chaîne |
| Problème spécifique | Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne |
| État | État de l’alarme. Valeurs valides :
Prêt.Si l’état est Valeur par défaut : prêt Type de données : chaîne |
Demande cURL
Cet exemple crée une alarme.
curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
"externalAlarmId":"<external-alarm-id>",
"alarmType":"QualityOfServiceAlarm",
"type":"QualityOfServiceAlarm",
"ackState":"acknowledged",
"perceivedSeverity":"CRITICAL",
"probableCause":"Threshold crossed",
"specificProblem":"Inbound Traffic threshold crossed",
"alarmedObjectType":"ROUTER",
"alarmedObject":{
"id":"vManage_000000",
"href":" http://api/alarmedobject/000000"
},
"sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
"alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
"state":"RAISED",
"alarmChangedTime":"2017-08-15T07:04:15.666Z",
"proposedRepairActions":"Switch in standby equipment",
"alarmReportingTime":"2017-06-15T07:04:15.666Z",
"alarmRaisedTime":"2020-09-15T07:04:15.666Z",
"plannedOutageIndication":"IN_SERVICE",
"serviceAffecting":true,
"affectedService":[
{
"id":"SD WAN Enterprise Solutions",
"href":"http://api/service/vlan_dot0_dot0"
},
{
"id":"Santa Clara SD WAN Application Service",
"href":"http://api/service/vlan_dot0_dot0"
}
]
}" \
--user 'user':'password'Corps de réponse.
{
"href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
"externalAlarmId":"<external-alarm-id>",
"alarmType":"QualityOfServiceAlarm",
"type":"QualityOfServiceAlarm",
"ackState":"acknowledged",
"perceivedSeverity":"CRITICAL",
"probableCause":"Threshold crossed",
"specificProblem":"Inbound Traffic threshold crossed",
"alarmedObjectType":"ROUTER",
"alarmedObject":{
"id":"vManage_000000",
"href":" http://api/alarmedobject/000000"
},
"sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
"alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
"state":"RAISED",
"alarmChangedTime":"2017-08-15T07:04:15.666Z",
"proposedRepairActions":"Switch in standby equipment",
"alarmReportingTime":"2017-06-15T07:04:15.666Z",
"alarmRaisedTime":"2020-09-15T07:04:15.666Z",
"plannedOutageIndication":"IN_SERVICE",
"serviceAffecting":true,
"affectedService":[
{
"id":"SD WAN Enterprise Solutions",
"href":"http://api/service/vlan_dot0_dot0"
},
{
"id":"Santa Clara SD WAN Application Service",
"href":"http://api/service/vlan_dot0_dot0"
}
]
}API ouverte de gestion des alarmes : POST /sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear
Efface une alarme spécifiée et ferme toute alerte associée.
Format d'URL
URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Identificateur unique de l’alarme à effacer. Situé dans le champ Clé du message de la table Événements [em_events]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| alarmClearedTime | Date et heure auxquelles l’alarme s’efface à la source. Cette valeur se trouve dans le champ de l’enregistrement Time of event dans la table Événements [em_events]. Type de données : chaîne |
| clearSystemId (en anglais seulement) | Requis. Nom de l’instance à partir de laquelle l’opération alarmCleared a été invoquée. Type de données : chaîne |
| clearUserId (en anglais seulement) | Requis. ID unique de l’utilisateur qui a invoqué l’opération alarmCleared . Cette valeur se trouve dans le champ de l’enregistrement Source dans la table Événements [em_events]. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| Nom | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Raisons possibles :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| alarmClearedTime | Date et heure auxquelles l’alarme s’efface à la source. Cette valeur se trouve dans le champ de l’enregistrement Time of event dans la table Événements [em_events]. Type de données : chaîne |
| clearSystemId (en anglais seulement) | Nom de l’instance à partir de laquelle l’opération alarmCleared a été invoquée. Type de données : chaîne |
| clearUserId (en anglais seulement) | ID unique de l’utilisateur qui a invoqué l’opération alarmCleared . Cette valeur se trouve dans le champ de l’enregistrement Source dans la table Événements [em_events]. Type de données : chaîne |
| href | URL de l’alarme. Type de données : chaîne |
| id | ID unique dans le Message key champ d’un enregistrement dans la table Événements [em_events]. Type de données : chaîne |
Demande cURL
Cet exemple efface une alarme.
curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"alarmClearedTime\": \"2017-08-15 06:04:15\",
\"clearSystemId\": \"<source_instance_name>\",
\"clearUserId\": \"SOURCE_SYSTEM_vManage_00000_000_00\"
}" \
--user 'user':'password'Corps de réponse.
{
"result": {
"alarmClearedTime": "2017-08-15 06:04:15",
"clearSystemId": "<source_instance_name>",
"clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00",
"id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
}
}