Types de notification

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

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) - - 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 partagée avec le client au cours du processus d'intégration.
Verb``String - - Mise à jour. Ceci indique qu'il y a une mise à jour de 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 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 suivants :

Body``Object - - Un objet contenant les détails de la notification. Les attributs au sein 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 envoyée.
- State - String - Indique l'état actuel de la commande. Valeur prise en charge - « fermé ».
- Description``Object - - Résumé du ticket du système de facturation.
- LineDetails - ArrayUn tableau d'objets contenant les détails des éléments facturés et du datacentre :
  - Id - Identifiant de ligne de facturation unique.
  - Ibx - Nom du datacenter/IBX.
  - Status - Valeur prise en charge « facturée ».
  - BilledLines - Array[String] Liste des articles facturés

Notifications relatives aux Fabric

La passerelle de messagerie prend en charge les notifications Fabric pour les workflows suivants :

Port de la Fabric Fabric montée/descente
Connexion virtuelle de la Fabric Fabric 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 - - Un objet contenant les détails de la notification. Les attributs au sein 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 La connexion virtuelle Fabric indiquée 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 - - Un objet contenant les détails du port client.
  - type``String - - Indique le type de port. XF_PORT 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 liés au statut du port client.
    - operationalStatus``String - - Indique l'état actuel du port client.
    - opStatusChangedAt``String - - Indique la date et l'heure auxquelles le statut 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] - Une baie contenant la liste des connexions virtuelles actives sur ce port client.

Notifications IBX

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

Messaging Gateway prend en charge les variantes de notifications IBX suivantes :

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": "Equinix Customer Support https://www.equinix.com/contact-us/customer-support",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==  
"  
}

Les notifications IBX ont les attributs suivants :

Body``Object - - Un objet contenant les détails de la notification. Les attributs au sein 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/l'incident du datacentre.
- State``String - - État actuel du ticket valeurs prises en charge :
  - CONFIRMED - La maintenance/l'incident du datacentre est confirmé.
  - IN-PROCESS - Maintenance/incident du datacentre en cours.
  - COMPLETED - La maintenance/l'incident du datacentre est terminé.
  - CANCELLED - La maintenance/l'incident du datacentre a été annulé.
- Description``Object - - 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 sera renseignée uniquement pour Etat 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/la gravité de l'impact sur le client dû à l'activité de maintenance 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 n'interrompt 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 renvoyer plus d'informations sur l'activité de maintenance.
- Organizer``String - - Indique le nom de l'organisateur de la maintenance. Service client d'Equinix.
- Assets``Object - - Cette valeur sera renseignée pour les ressources de types « datacenter.maintenance » et « datacenter.incident ». Objet contenant les détails des actifs client impactés avec les attributs suivants :
  - 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 de réseau de produit ou de service 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": "Equinix Customer Support https://www.equinix.com/contact-us/customer-support",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

Les notifications de réseau ont les attributs suivants :

Body``Object - - Un objet contenant les détails de la notification. Les attributs au sein 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/l'incident du réseau.
- State``String - - État actuel du ticket valeurs prises en charge :
  - CONFIRMED - La maintenance/l'incident du datacentre est confirmé.
  - IN-PROCESS - Maintenance/incident du datacentre en cours.
  - COMPLETED - La maintenance/l'incident du datacentre est terminé.
  - CANCELLED - La maintenance/l'incident du datacentre a été annulé.
- Description``Object - - 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 « réseau.maintenance ». Cette valeur sera renseignée uniquement 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/la gravité de l'impact sur le client dû à l'activité de maintenance 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 n'interrompt 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 renvoyer plus d'informations sur l'activité de maintenance.
- Organizer``String - - Indique le nom de l'organisateur de la maintenance. Service client d'Equinix.
- Assets - Object - Cette valeur sera renseignée pour les ressources de types « Network.maintenance » et « Network.incident ». Objet contenant les détails des actifs client impactés avec les attributs suivants :
  - 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 EMG. Ces notifications fournissent des mises à jour sur le statut de vos commandes au fur et à mesure de leur progression à travers les différentes étapes, y compris la création, la planification, les mises à jour et l'exécution.

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 - - Un objet contenant les détails de la notification de commande. Les attributs au sein 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 une commande.
- ServicerId - String - Le numéro de commande unique fourni par Equinix pour la commande envoyée. Également appelé numéro de commande.
- ActivityId``String - - Identifiant d'activité unique pour des articles ou des sous-tâches spécifiques au sein d'une commande.
- State - String - L'état actuel de la commande. Les états courants incluent :
  - Open - La commande a été reçue et est en cours de révision
  - InProgress - Des travaux sont en cours sur la commande
  - Completed - La commande a été complétée avec succès
  - Cancelled - La commande a été annulée
  - Pending Customer Input - Equinix nécessite des informations supplémentaires ou 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 e-mail de contact client principale associée à la commande.
- Location``String - - L'emplacement du datacentre IBX où la commande est exécutée.
- ServiceDetails``Object - - Détails spécifiques au type de commande effectuée. 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 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)

Notifications de facturation​

Notifications relatives aux Fabric​

Notifications IBX​

Notifications réseau​

Notifications de commande​

Notifications de facturation

Notifications relatives aux Fabric

Notifications IBX

Notifications réseau

Notifications de commande