Skip to main content

Type de notification

Chaque notification envoyée par Messaging Gateway a un format commun, selon le type de notification. La structure du message de notification est également décrite dans la documentation AsyncAPI .

Tous les messages sortants d'Equinix comportent 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 sont applicables à tous les types de commande.

  • ID - String (GUID) - L'identifiant unique du message. Equinix envoie une valeur unique pour chaque message.
  • source - String (GUID) - Une valeur unique pour identifier l'expéditeur du message. Cette valeur sera partagée avec le client au cours du processus d'intégration.
  • Verb - String - mise à jour. Cela indique qu'il existe une mise à jour 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 de 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 client est clôturée et que la facturation est démarrée par Equinix. Ces notifications seront déclenchées pour toutes les commandes des clients soumises via les 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 l'objet varient en fonction de la ressource et du verbe.
    • RequestorId - String - numéro de référence client pour la maintenance (le cas échéant).
    • ServicerId - String - indique l'identifiant unique fourni par Equinix pour la commande envoyée.
    • State - String - indique l'état actuel de l'ordre. Valeur prise en charge - 'fermé'.
    • Description - objet - Résumé du ticket du système de facturation.
    • LineDetails - Array - un tableau d'objets contenant les détails des éléments de ligne facturés et du centre de données :
      • ID - ID de ligne de facturation unique.
      • IBX - nom du datacenter/IBX.
      • Status - valeur supportée "Billed".
      • BilledLines - Array[String] liste des articles facturés

Notifications Fabric​

Messaging Gateway prend en charge les notifications Fabric pour les flux de travail ci-dessous :

  • Produit pour port Equinix Fabric
  • Produit de connexion virtuelle Equinix Fabric

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 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 en cours de maintenance. CONNECTION_OPSTATUS_NOTIFICATION indique que Fabric Virtual Connection est actuellement en cours de maintenance.
    • UUID - String - indique l'ID unique fourni par Equinix pour la maintenance.
    • description - String - Résumé du ticket 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 le port Fabric Equinix. EVPL_VC indique une connexion virtuelle Fabric Equinix.
      • uuid - String - indique l'ID 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.
      • opération - objet - un objet contenant les détails liés à 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 - booléen - indique si c'est une maintenance planifiée ou non.
      • 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 toute maintenance planifiée ou non du datacenter Equinix IBX. Ces notifications sont également déclenchées pour tout incident ou conseil de centre de données IBX 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
  • Incident 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": "Equinix Customer Support https://www.equinix.com/contact-us/customer-support",  
    "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 l'objet varient en fonction de la ressource et du verbe.
    • RequestorId - String - numéro de référence client pour la maintenance (le cas échéant).
    • ServicerId - String - indique l'ID unique fourni par Equinix pour la maintenance/l'incident du datacenter.
    • State - String - Etat actuel du ticket valeurs prises en charge :
      • CONFIRMÉ - la maintenance/l'incident du datacenter est confirmé.
      • IN-PROCESS - maintenance/incident du datacenter en cours.
      • COMPLETED - la maintenance/incident du datacenter est terminée.
      • ANNULÉ - la maintenance/l'incident du datacenter a été annulé.
    • Description - objet - Résumé du ticket d'un technicien Equinix.
    • Sequence - Number - incrémenter le nombre pour les notifications associées. 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 ressource de type « datacenter ». Maintenance" cette valeur ne sera renseignée pour State que comme COMPLETED pour les types de ressource - 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/gravité de l'impact sur le client en raison de l'activité de maintenance ou de l'incident. Valeurs prises en charge :
      • SERVICE_IMPACTANT - indique l'activité ou l'incident qui affecte vos services.
      • NON_SERVICE_IMPACTANT - 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 vers le plus d'informations sur l'activité de maintenance.
    • Organizer - String - indique le nom de l'organisateur de maintenance. Assistance clientèle Equinix .
    • Assets - Object - cette valeur sera renseignée pour les ressources de types "datacenter.maintenance" et "datacenter.incident". Un objet contenant les détails des actifs client impactés avec les attributs :
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notifications réseau​

Les notifications réseau sont des notifications en temps quasi réel pour toute maintenance planifiée ou non du réseau de service ou de produit Equinix. Ces notifications sont également déclenchées pour tout incident produit ou réseau de service Equinix.

Messaging Gateway 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": "Equinix Customer Support https://www.equinix.com/contact-us/customer-support",  
    "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 l'objet varient en fonction de la ressource et du verbe.

    • RequestorId - String - numéro de référence client pour la maintenance (le cas échéant).
    • ServicerId - String - indique l'ID unique fourni par Equinix pour la maintenance/l'incident du réseau.
    • State - String - Etat actuel du ticket valeurs prises en charge :
      • CONFIRMÉ - la maintenance/l'incident du datacenter est confirmé.
      • IN-PROCESS - maintenance/incident du datacenter en cours.
      • COMPLETED - la maintenance/incident du datacenter est terminée.
      • ANNULÉ - la maintenance/l'incident du datacenter a été annulé.
    • Description - objet - Résumé du ticket d'un technicien Equinix.
    • Sequence - Number - incrémenter le nombre pour les notifications associées. 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 la ressource de type "Network.maintenance" cette valeur ne sera renseignée que pour l'état comme COMPLETED pour la ressource de type Network.incident.
    • AccountNumber - String - indique le numéro de compte du client lié à l'activité de maintenance.
    • impact - String - indique le niveau/gravité de l'impact sur le client en raison de l'activité de maintenance ou de l'incident. Valeurs prises en charge :
      • SERVICE_IMPACTANT - indique l'activité ou l'incident qui affecte vos services.
      • NON_SERVICE_IMPACTANT - 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 vers le plus d'informations sur l'activité de maintenance.
    • Organizer - String - indique le nom de l'organisateur de maintenance. Assistance clientèle Equinix .
    • Assets - Object - cette valeur sera renseignée pour les ressources de types "Network.maintenance" et "Network.incident". Un objet contenant les détails des actifs 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 clients, les API ou EMG. Ces notifications fournissent des mises à jour sur l'état de vos commandes à mesure qu'elles progressent à travers 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 commande suivants :

  • Commande de Cross Connects
  • Commande Smart Hands
  • Numéro de commande de l'accès temporaire
  • Identifiant de la commande d'envoi
  • Commandes de tickets d'incident

Notification de commande d'échantillon :

{  
"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 de corps suivants :

  • body - Object - un objet contenant les détails de la notification de commande. Les attributs de l'objet varient en fonction de la ressource et de l'état.
    • RequestorId - String - numéro de référence client pour la commande. Il s'agit de l'identifiant unique que vous pouvez fournir lorsque vous passez des commandes.
    • ServicerId - String - le numéro de commande unique fourni par Equinix pour la commande envoyée. Également appelé numéro de commande.
    • ActivityId - String - L'identificateur d'activité unique pour des articles ou des sous-tâches spécifiques dans une commande.
    • State - String - L'état actuel de la commande. les états les plus courants sont les suivants :
      • ouvert - la commande a été reçue et est en cours d'examen
      • InProgress - le travail est en cours sur la commande
      • Completed - la commande a été complétée avec succès
      • annulé - la commande a été annulée
      • « Contribution client en attente » - Equinix nécessite des informations supplémentaires ou l'approbation du client
      • en attente - la commande est temporairement suspendue
    • Description - String - Une description détaillée de l'état actuel de la commande ou des messages des techniciens Equinix.
    • CustomerContact - String - L'adresse e-mail de contact client principale 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 de commande en cours d'exécution. Le contenu varie selon le type de commande :
      • Pour les mains intelligentes : scopeOfWork, startDateTime, endDateTime, détails de l'équipement
      • Pour Cross Connect : informations sur le panneau de brassage, détails sur le circuit, types de connecteurs
      • Pour la visite de travail : informations sur le visiteur, objectif, 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 tableau de pièces jointes liées à 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 - Télécharger l'URL de la pièce jointe (si disponible)
Cette page vous a-t-elle été utile ?