Skip to main content

Types de notifications

Chaque notification envoyée par la passerelle de messagerie a un format commun, qui dépend de son type. La structure des messages de notification est aussi décrite dans la documentation AsyncAPI.

Tous les messages sortants d' Equinix contiennent les composants 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 s’appliquent à tous les types de commandes.

  • ID - String (Guid) - L'identificateur unique du message. Equinix enverra une valeur unique pour chaque message.
  • Source - String (Guid) - Une valeur unique permettant d'identifier l'expéditeur du message. Cette valeur sera communiquée au client lors de son inscription.
  • Verb - String - Mise à jour. Cela indique qu'une mise à jour est disponible auprès 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 quasi instantanées déclenchées lorsque la commande du client est fermée et La facturation est initiée par Equinix. Ces notifications seront envoyées pour toutes les commandes passées par les clients. par le biais de canaux hors ligne et en 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 de corps suivants:

  • Body - Object - Un objet contenant les détails de la notification. Les attributs de cet objet varient selon la ressource et le 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: « Fermée ».
    • Description - Object - Résumé du billet du système de facturation.
    • LineDetails - Array - Un tableau d'objets contenant les détails des lignes de facturation et du centre de données:
      • Id - Identificateur unique de la ligne de facturation.
      • Ibx - Nom du centre de données/ IBX.
      • Status - Valeur prise en charge « Facturé ».
      • Liste des lignes de facturation BilledLines - Array[String]

Notifications de tissu​

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

  • Port Equinix Fabric haut/bas
  • Connexion virtuelle Equinix Fabric haut/bas

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 Fabric ont les attributs de corps suivants:

  • Body - Object - Un objet contenant les détails de la notification. Les attributs de cet objet varient selon la ressource et le verbe.
    • type - String - Indique le type de notification. PORT_OPSTATUS_NOTIFICATION indique que le port Fabric est actuellement en maintenance. CONNECTION_OPSTATUS_NOTIFICATION indique que la connexion virtuelle Fabric est actuellement en maintenance.
    • uuid - String - Indique l'identifiant unique fourni par Equinix pour la maintenance.
    • description - String - Résumé du billet d'un technicien Equinix .
    • data - Object - Un objet contenant les détails du port client.
      • type - String - Indique le type de port. XF_PORT indique un 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 - Un 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 auxquelles l'état du port client a été surveillé pour la dernière fois.
        • maintenanceMode - Boolean - Indique s'il s'agit d'une maintenance planifiée ou non planifiée.
      • embedded - Object - Un objet contenant les détails des connexions virtuelles actives sur ce port client.
        • connections - Object - Un 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 tout centre de données Equinix IBX planifié ou non. maintenance. Ces notifications sont également déclenchées pour tout incident survenu dans un centre de données Equinix IBX et consultatif.

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

  • Notifications de maintenance IBX
  • Notifications d'incidents IBX
  • Avis de conseil 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 de corps suivants:

  • Body - Object - Un objet contenant les détails de la notification. Les attributs de cet objet varient selon la ressource et le 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/l'incident du centre de données.
    • State - String - État actuel du ticket. Valeurs prises en charge:
      • CONFIRMED - Entretien/incident du centre de données confirmé.
      • IN-PROCESS - Entretien/incident du centre de données en cours.
      • COMPLETED - Entretien/incident du centre de données terminé.
      • CANCELLED - Entretien/incident du centre de données annulé.
    • Description - Object - Résumé du billet d'un technicien Equinix .
    • Sequence - Number - Numéro incrémentiel des notifications associées. Le numéro 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 la ressource de type « Maintenance du centre de données ». La valeur COMPLETED sera renseignée seulement pour l'état des 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 dû à l'activité d'entretien ou à 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 sauvegarde maintiennent les choses en marche malgré les réparations.
    • ProdID - String - Indique le lien permettant de consulter plus d'informations sur l'activité de maintenance.
    • Organizer - String - Indique le nom de l'organisateur de la maintenance avec son adresse e-mail. Service d'assistance mondial: 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 client touchés, avec les attributs suivants:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notifications réseau​

Les notifications réseau sont des notifications en temps réel pour tout produit Equinix, planifié ou non. Entretien du réseau de service. Ces notifications sont également déclenchées pour tout produit ou service Equinix. Incidents de réseau.

La passerelle de messagerie prend en charge les variantes de notifications réseau ci-dessous

  • Notifications de maintenance du réseau
  • Notifications d'incidents 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 réseau ont les attributs de corps suivants:

  • Body - Object - Un objet contenant les détails de la notification. Les attributs de cet objet varient selon la ressource et le 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/l'incident du réseau.
    • State - String - État actuel du ticket. Valeurs prises en charge:
      • CONFIRMED - Entretien/incident du centre de données confirmé.
      • IN-PROCESS - Entretien/incident du centre de données en cours.
      • COMPLETED - Entretien/incident du centre de données terminé.
      • CANCELLED - Entretien/incident du centre de données annulé.
    • Description - Object - Résumé du billet d'un technicien Equinix .
    • Sequence - Number - Numéro incrémentiel des notifications associées. Le numéro 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 sera renseignée seulement 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 dû à l'activité d'entretien ou à 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 sauvegarde maintiennent les choses en marche malgré les réparations.
    • ProdID - String - Indique le lien permettant de consulter plus d'informations sur l'activité de maintenance.
    • Organizer - String - Indique le nom de l'organisateur de la maintenance avec son adresse e-mail. Service d'assistance mondial: 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 client touchés, avec les attributs suivants:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notifications de commande​

Les notifications de commande sont des notifications quasi instantanées pour les commandes passées par le portail client, les API ou EMG. Ces notifications fournissent des mises à jour sur l'état de vos commandes à mesure qu'elles progressent à travers leurs différentes étapes, notamment la création, la planification, les mises à jour et la finalisation.

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

  • Commandes Cross Connect
  • Commandes Smart Hands
  • Ordres de visite de travail
  • Commandes d'expédition
  • Commandes de billets d'incident

Exemple d'avis 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 comportent les attributs de corps suivants:

  • Body - Object - Objet contenant les détails de la notification de commande. Les attributs de cet objet varient selon la ressource et 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 lors de la passation de commandes.
    • ServicerId - String - Numéro de commande unique fourni par Equinix pour la commande soumise. Aussi appelé numéro de commande.
    • ActivityId - String - L'identificateur unique de l'activité pour des éléments de ligne ou des sous-tâches spécifiques au sein d'une commande.
    • State - String - État actuel de la commande. États courants:
      • Open - La commande a été reçue et est en cours de vérification.
      • InProgress - Des travaux sont présentement en cours sur la commande
      • Completed - La commande a été finalisée avec succès
      • Cancelled - Commande annulée
      • Pending Customer Input - Equinix a besoin de renseignements supplémentaires ou de l'approbation du client.
      • On Hold - La commande est temporairement suspendue
    • Description - String - Une description détaillée de l'état actuel de la commande ou de tout message des techniciens Equinix .
    • CustomerContact - String - L'adresse courriel principale de contact client associée à 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 d'ordre exécuté. Le contenu varie selon le type d'ordre:
      • Pour Smart Hands: étendue des travaux, date et heure de début, date et heure de fin, détails du matériel
      • Pour Cross Connect: renseignements sur les panneaux de brassage, détails des circuits, types de connecteurs
      • Visite professionnelle: renseignements sur le visiteur, motif, durée
      • Pour les envois: renseignements sur le transporteur, numéros de suivi, instructions de livraison
      • Pour les billets d'incident: description du problème, gravité, services concernés
    • Attachments - Array - Un ensemble de pièces jointes relatives à la commande. Chaque pièce jointe comprend:
      • Id - Identificateur unique de la pièce jointe
      • Name - Nom du fichier ci-joint
      • Url - URL de téléchargement de la pièce jointe (le cas échéant)
Cette page vous a-t-elle été utile ?