Skip to main content

Types de notification

Chaque notification envoyée par la Messaging Gateway a un format commun, en fonction du type de notification. La structure des messages de notification est également décrite dans la [documentation AsyncAPI] (/api-catalog/emgv1/).

Tous les messages sortants d'Equinix comportent les éléments suivants :

{  
"Task": {  
    "Header attribute 1": "",  
    "Header attribute 2": "",  
    "Header attribute 3": "",  
    ...  
    "Body": {  
    "Body attribute 1": "",  
    "Body attribute 2": "",  
    "Body attribute 3": "",  
    ...  
    }  
},  
"Signature": "Base 64 encrypted signature"  
}

Ces attributs d'en-tête sont applicables à tous les types de commandes.

  • ID - String (Guid) - L'identifiant unique du message. Equinix enverra une valeur unique pour chaque message.
  • Source - String (Guid) - Une valeur unique pour identifier l'expéditeur du message. Cette valeur sera communiquée au client au cours du processus d'intégration.
  • Verb - String - Mise à jour. Ceci indique qu'il y a une mise à jour de la part d'Equinix.
  • Resource - String - Nom du produit Equinix pour lequel la notification est envoyée.
  • ContentType - String - "application/json"
  • CreateTimeUTC - String - Indique la date et l'heure auxquelles la notification est envoyée par Equinix.
  • Version - String - La version du schéma de notification.

Les attributs du corps varient pour chaque type de notification.

Notifications de facturation​

Les notifications de facturation sont des notifications en temps quasi réel déclenchées lorsque la commande du client est clôturée et que la facturation est lancée par Equinix. Ces notifications sont déclenchées pour toutes les commandes de clients passées par des canaux en ligne ou hors ligne.

Les revendeurs recevront également des notifications de facturation lorsque la facturation commencera pour les commandes passées par les clients.

Exemple de notification :

{  
"Task": {  
    "Id": "la83ef18-5e36-4a2d-9d80-490ee217d004",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "CrossConnnect",  
    "ContentType": "application/json",  
    "CreationTimeUTC": "2021-06-16T19:57:21.326Z",  
    "Version": "1.0",  
    "Body": {  
    "RequestorId": "",  
    "ServicerId": "1-205346710865",  
    "State": "Closed",  
    "Description": "Order Number:1-205346710865 billing notification",  
    "LineDetails": [  
        {  
        "Id": "1-3N5W5LYZ",  
        "Ibx": "DC1",
        "Status": "Billed",  
        "BilledLines": [  
            "1-2N5W4JAS",  
            "1-2N5W4K87",  
            "1-2N5W3M21",  
            "1-2N5235N2"  
        ]  
        }  
    ]  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

Les notifications de facturation ont les attributs suivants :

  • Body - Object - Objet contenant les détails de la notification. Les attributs de l'objet varient en fonction de la ressource et du verbe.
    • RequestorId - String - Numéro de référence du client pour la maintenance (le cas échéant).
    • ServicerId - String - Indique l'identifiant unique fourni par Equinix pour la commande soumise.
    • State - String - Indique l'état actuel de la commande. Valeur prise en charge - "Closed".
    • Description - Object - Résumé du ticket du système de facturation.
    • LineDetails - Array - Un tableau d'objets contenant les détails des postes facturés et du centre de données :
      • Id - Identifiant unique de la ligne de facturation.
      • Ibx - Nom du centre de données/IBX.
      • Status - Valeur prise en charge "Billed".
      • BilledLines - Array[String] Liste des postes facturés

Notifications relatives aux tissus​

La passerelle de messagerie prend en charge les notifications de Fabric pour les flux de travail ci-dessous :

  • Port Up/Down de la Fabric Equinix
  • Connexion virtuelle de la Fabric Equinix Up/Down

Exemple de notification :

{  
"Task": {  
    "Id": "bf9f2707-d612-4d63-9958-4c8b1fcf3cc0",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "DataCenter.Network.Port",  
    "ContentType": "application/json",  
    "Version": "1.0",  
    "Body": {   
    "timestamp":"2020-05-21T10:20:00Z",  
    "type":"PORT_OPSTATUS_NOTIFICATION",  
    "uuid":"11c954fb-8e8b-4515-97d7-cc80129a0985",  
    "description":"Port is not operational. Connections on this port might be affected.",  
    "data":{  
        "type":"XF_PORT",  
        "uuid":"a867f685-41b0-1b07-6de0-320a5c00abdd",  
        "name":"L2-DEV-USER01-DC5-CX-10G-SECONDARY-NOKIA-02",  
        "href":"https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",  
        "operation":{  
            "operationalStatus":"DOWN",  
            "opStatusChangedAt":"2020-05-21T10:20:00Z",  
            "maintenanceMode":false  
        },  
        "embedded":{  
            "connections":{  
                "href":[  
                "https://api.equinix.com/fabric/v4/connections/8822de74-805f-4f63-b52d-93bcbf2a1d1b",  
                "https://api.equinix.com/fabric/v4/connections/8f20bea9-a5b9-47e5-88e6-a899584ebb90"  
                ]  
            }  
        }  
    }  
  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

Les notifications de Fabric ont les attributs suivants :

  • Body - Object - Objet contenant les détails de la notification. Les attributs de l'objet varient en fonction de la ressource et du verbe.
    • type - String - Indique le type de notification. PORT_OPSTATUS_NOTIFICATION indique que le port Fabric est actuellement en cours de maintenance. CONNECTION_OPSTATUS_NOTIFICATION indique que la connexion virtuelle Fabric est actuellement en cours de maintenance.
    • uuid - String - Indique l'identifiant unique fourni par Equinix pour la maintenance.
    • description - String - Résumé du ticket d'un technicien Equinix.
    • data - Object - Objet contenant les détails du port du client.
      • type - String - Indique le type de port. XF_PORT indique le port Equinix Fabric. EVPL_VC indique une connexion virtuelle Equinix Fabric.
      • uuid - String - Indique l'identifiant unique du port client.
      • name - String - Indique le nom du port client.
      • href - String - Lien pour obtenir plus de détails sur le port client.
      • operation - Object - Objet contenant les détails relatifs à l'état du port client.
        • operationalStatus - String - Indique l'état actuel du port client.
        • opStatusChangedAt - String - Indique la date et l'heure de la dernière surveillance de l'état du port client.
        • maintenanceMode - Boolean - Indique s'il s'agit d'une maintenance planifiée ou non planifiée.
      • embedded - Object - Objet contenant les détails des connexions virtuelles actives sur ce port client.
        • connections - Object - Objet contenant la liste des connexions virtuelles actives sur ce port client.
          • href - Array[String] - Un tableau contenant la liste des connexions virtuelles actives sur ce port client.

Notifications IBX​

Les notifications IBX sont des notifications en temps quasi réel pour toute maintenance planifiée ou non planifiée des datacenters IBX d'Equinix. Ces notifications sont également déclenchées en cas d'incidents et d'avis concernant les datacenters IBX d'Equinix.

Messaging Gateway prend en charge les variantes de notifications IBX ci-dessous :

  • Notifications de maintenance IBX
  • Notifications d'incidents IBX
  • Notifications d'avis IBX
  • Notifications d'incidents de sécurité IBX

Exemple de notification :

{  
"Task": {  
    "Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "DataCenter.Maintenance",  
    "ContentType": "application/json",  
    "CreationTimeUTC": "2021-06-09T07:42:45.396Z",  
    "Version": "1.0",  
    "Body": {  
    "RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",  
    "ServicerId": "5-204454471282",  
    "State": "CONFIRMED",  
    "Description": "Equinix Test Maintenance",  
    "Sequence": "2",  
    "StartDateTime": "2021-03-29T17:33:00",  
    "EndDateTime": "2021-03-31T18:00:00",  
    "AccountNumber": "123456",  
    "Impact": "NON_SERVICE_IMPACTING",  
    "ProdID": "DataCenter Notification https://developer.equinix.com",  
    "Organizer": "Global Service Desk:mailto:cs@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==  
"  
}

Les notifications IBX ont les attributs suivants :

  • Body - Object - Objet contenant les détails de la notification. Les attributs de l'objet varient en fonction de la ressource et du verbe.
    • RequestorId - String - Numéro de référence du client pour la maintenance (le cas échéant).
    • ServicerId - String - Indique l'identifiant unique fourni par Equinix pour la maintenance ou l'incident du centre de données.
    • State - String - État actuel du ticket Valeurs prises en charge :
      • CONFIRMED - La maintenance/incident du centre de données est confirmée.
      • IN-PROCESS - Maintenance/incident du centre de données en cours.
      • COMPLETED - L'entretien/incident du centre de données est terminé.
      • CANCELLED - L'entretien/incident du centre de données a été annulé.
    • Description - Object - Résumé du ticket d'un technicien Equinix.
    • Sequence - Number - Nombre incrémentiel pour les notifications correspondantes. Le nombre commence à 0.
    • StartDateTime - String - Indique la date et l'heure de début de la maintenance.
    • EndDateTime - String - Indique la date et l'heure de fin de la maintenance. Cette valeur sera toujours renseignée pour les ressources de type "DataCenter. Maintenance" Cette valeur ne sera renseignée que pour l'état COMPLETED pour les types de ressources DataCenter.Incident, DataCenter.SecurityIncident et DataCenter.Advisory.
    • AccountNumber - String - Indique le numéro de compte du client lié à l'activité de maintenance.
    • Impact - String - Indique le niveau/la gravité de l'impact sur le client de l'activité de maintenance ou de l'incident. Valeurs prises en charge :
      • SERVICE_IMPACTING - indique l'activité ou l'incident qui affecte vos services.
      • NON_SERVICE_IMPACTING - indique l'activité ou l'incident qui ne perturbe pas vos services, comme lorsque les serveurs de secours continuent de fonctionner malgré les réparations.
    • ProdID - String - Indique le lien permettant d'obtenir plus d'informations sur l'activité de maintenance.
    • Organizer - String - Indique le nom de l'organisateur de la maintenance avec son adresse électronique. Global Service Desk : cs@equinix.com.
    • Assets - Object - Cette valeur sera renseignée pour les ressources de type "DataCenter.Maintenance" et "DataCenter.Incident". Un objet contenant les détails des actifs du client impactés avec les attributs :
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notifications du réseau​

Les notifications de réseau sont des notifications en temps quasi réel pour toute maintenance planifiée ou non planifiée du réseau de produits ou de services d'Equinix. Ces notifications sont également déclenchées en cas d'incident sur le réseau de produits ou de services Equinix.

Messaging Gateway prend en charge les variantes de notifications réseau suivantes

  • Notifications de maintenance du réseau
  • Notifications d'incidents de réseau

Exemple de notification :

{  
"Task": {  
    "Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "Network.Maintenance",  
    "ContentType": "application/json",  
    "CreationTimeUTC": "2021-06-09T07:42:45.396Z",  
    "Version": "1.0",  
    "Body": {  
    "RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",  
    "ServicerId": "5-204454471282",  
    "State": "CONFIRMED",  
    "Description": "Equinix Test Maintenance",  
    "Sequence": "2",  
    "StartDateTime": "2021-03-29T17:33:00",  
    "EndDateTime": "2021-03-31T18:00:00",  
    "AccountNumber": "123456",  
    "Impact": "NON_SERVICE_IMPACTING",  
    "ProdID": "Network Notification https://developer.equinix.com",  
    "Organizer": "Global Service Desk:mailto:cs@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

Les notifications de réseau ont les attributs suivants :

  • Body - Object - Objet contenant les détails de la notification. Les attributs de l'objet varient en fonction de la ressource et du verbe.

    • RequestorId - String - Numéro de référence du client pour la maintenance (le cas échéant).
    • ServicerId - String - Indique l'identifiant unique fourni par Equinix pour la maintenance/incident du réseau.
    • State - String - État actuel du ticket Valeurs prises en charge :
      • CONFIRMED - La maintenance/incident du centre de données est confirmée.
      • IN-PROCESS - Maintenance/incident du centre de données en cours.
      • COMPLETED - L'entretien/incident du centre de données est terminé.
      • CANCELLED - L'entretien/incident du centre de données a été annulé.
    • Description - Object - Résumé du ticket d'un technicien Equinix.
    • Sequence - Number - Nombre incrémentiel pour les notifications correspondantes. Le nombre commence à 0.
    • StartDateTime - String - Indique la date et l'heure de début de la maintenance.
    • EndDateTime - String - Indique la date et l'heure de fin de la maintenance. Cette valeur sera toujours renseignée pour les ressources de type "Network.Maintenance". Cette valeur ne sera renseignée que pour l'état COMPLETED pour les ressources de type Network.Incident.
    • AccountNumber - String - Indique le numéro de compte du client lié à l'activité de maintenance.
    • Impact - String - Indique le niveau/la gravité de l'impact sur le client de l'activité de maintenance ou de l'incident. Valeurs prises en charge :
      • SERVICE_IMPACTING - indique l'activité ou l'incident qui affecte vos services.
      • NON_SERVICE_IMPACTING - indique l'activité ou l'incident qui ne perturbe pas vos services, comme lorsque les serveurs de secours continuent de fonctionner malgré les réparations.
    • ProdID - String - Indique le lien permettant d'obtenir plus d'informations sur l'activité de maintenance.
    • Organizer - String - Indique le nom de l'organisateur de la maintenance avec son adresse électronique. Global Service Desk : cs@equinix.com.
    • Assets - Object - Cette valeur sera renseignée pour les ressources de type "Network.Maintenance" et "Network.Incident". Un objet contenant les détails des actifs du client impactés avec les attributs :
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notifications de commande​

Les notifications de commande sont des notifications en temps quasi réel pour les commandes passées via le portail client, les API ou l'EMG. Ces notifications fournissent des mises à jour sur l'état de vos commandes au fur et à mesure qu'elles progressent à travers les différentes étapes, y compris la création, la planification, les mises à jour et l'achèvement.

Les notifications de commande sont disponibles pour les types de commandes suivants :

  • Commandes Cross Connect
  • Commandes Smart Hands
  • Commandes de visites de travail
  • Commandes d'expédition
  • Commandes de tickets de dérangement

Exemple de notification de commande :

{  
"Task": {  
    "Id": "a4f3d7e2-1a6c-4b8d-9e2f-3c5a8b7d9e1f",  
    "Source": "3e095d30-40ff-11e9-8959-5be078353003",  
    "Verb": "Update",  
    "Resource": "SmartHands",  
    "ContentType": "application/json",  
    "CreationTimeUTC": "2021-06-16T19:57:21.326Z",  
    "Version": "1.0",  
    "Body": {  
    "RequestorId": "CUSTOMER-REF-001",  
    "ServicerId": "1-205346710865",  
    "ActivityId": "1-3N5W5LYZ",  
    "State": "InProgress",  
    "Description": "Smart Hands order in progress - technician assigned",  
    "CustomerContact": "customer.contact@example.com",  
    "Location": "DC1",  
    "ServiceDetails": {  
        "scopeOfWork": "Equipment installation and cable management",  
        "startDateTime": "2021-06-17T09:00:00Z",  
        "endDateTime": "2021-06-17T11:00:00Z"  
    },  
    "Attachments": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

Les notifications de commande ont les attributs suivants :

  • Body - Object - Objet contenant les détails de la notification de la commande. Les attributs de l'objet varient en fonction de la ressource et de l'état.
    • RequestorId - String - Numéro de référence du client pour la commande. Il s'agit de l'identifiant unique que vous pouvez fournir lorsque vous passez des commandes.
    • ServicerId - String - Numéro de commande unique fourni par Equinix pour la commande soumise. Également appelé numéro de commande.
    • ActivityId - String - L'identifiant d'activité unique pour des postes ou des sous-tâches spécifiques au sein d'une commande.
    • State - String - L'état actuel de la commande. Les états les plus courants sont les suivants :
      • Open - La commande a été reçue et est en cours d'examen
      • InProgress - La commande est en cours d'exécution.
      • Completed - La commande a été complétée avec succès
      • Cancelled - La commande a été annulée
      • Pending Customer Input - Equinix a besoin d'informations complémentaires ou de l'approbation du client
      • On Hold - La commande est temporairement interrompue
    • Description - String - Une description détaillée de l'état actuel de la commande ou des messages des techniciens d'Equinix.
    • CustomerContact - String - L'email du contact principal du client associé à la commande.
    • Location - String - L'emplacement du centre de données IBX où la commande est exécutée.
    • ServiceDetails - Object - Détails spécifiques au type de commande en cours d'exécution. Le contenu varie selon le type de commande :
      • Pour Smart Hands : scopeOfWork, startDateTime, endDateTime, détails de l'équipement
      • Pour Cross Connect : informations sur les panneaux de brassage, détails des circuits, types de connecteurs
      • Visite de travail : informations sur le visiteur, objet, durée
      • Pour les envois : informations sur le transporteur, numéros de suivi, instructions de livraison.
      • Pour les tickets d'incident : description du problème, gravité, services affectés.
    • Attachments - Array - Un ensemble de pièces jointes relatives à la commande. Chaque pièce jointe comprend
      • Id - Identifiant unique de la pièce jointe
      • Name - Nom de fichier de la pièce jointe
      • Url - URL de téléchargement de la pièce jointe (si disponible)
Cette page vous a-t-elle été utile ?