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.

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) - The unique identifier of the message. Equinix will send a unique value for each message.
  • Source - String (Guid) - A unique value to identify the message sender. This value will be shared with the customer during the onboarding process.
  • Verb - String - Update. This indicates there is an update from Equinix.
  • Resource - String - Equinix Product Name for which the notification is being sent.
  • ContentType - String - "application/json"
  • CreateTimeUTC - String - Indicates the date and time at which the notification is sent by Equinix.
  • Version - String - The version of the notification schema.

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 - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
    • RequestorId - String - Customer reference number for the maintenance (if any).
    • ServicerId - String - Indicates the unique id supplied by Equinix for the submitted order.
    • State - String - Indicates the current state of Order. Supported Value - 'Closed'.
    • Description - Object - Summary of the ticket from Billing System.
    • LineDetails - Array - An array of object containing the details of the Billed Line Items and data center:
      • Id - Unique Billing Line ID.
      • Ibx - Name of the DataCenter/IBX.
      • Status - Supported value "Billed".
      • BilledLines - Array[String] List of Billed Line Items

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 - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
    • type - String - Indicates type of notification. PORT_OPSTATUS_NOTIFICATION indicates Fabric Port is currently under maintenance. CONNECTION_OPSTATUS_NOTIFICATION indicated Fabric Virtual Connection is currently under maintenance.
    • uuid - String - Indicates the unique id supplied by Equinix for the maintenance.
    • description - String - Summary of the ticket from an Equinix Technician.
    • data - Object - An object containing the details of the customer port.
      • type - String - Indicates port type. XF_PORT indicates Equinix Fabric Port. EVPL_VC indicates Equinix Fabric Virtual Connection.
      • uuid - String - Indicates the unique id of the customer port.
      • name - String - Indicates name of the customer port.
      • href - String - Link to get more details of the customer port.
      • operation - Object - An object containing the details related to the status of the customer port.
        • operationalStatus - String - Indicates the current status of the customer port.
        • opStatusChangedAt - String - Indicates the date and time at which the status of the customer port last monitored.
        • maintenanceMode - Boolean - Indicates if its a planned or unplanned maintenance.
      • embedded - Object - An object containing the details of the virtual connections active on this customer port.
        • connections - Object - An object containing the list of the virtual connections active on this customer port.
          • href - Array[String] - An array containing the list of the virtual connections active on this customer port.

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 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": "Global Service Desk:mailto:cs@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==  
"  
}

Les notifications IBX ont les attributs suivants :

  • Body - Object - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
    • RequestorId - String - Customer reference number for the maintenance (if any).
    • ServicerId - String - Indicates the unique id supplied by Equinix for the datacenter maintenance/incident.
    • State - String - Current State of the ticket Supported Values:
      • CONFIRMED - DataCenter Maintenance/Incident is Confirmed.
      • IN-PROCESS - DataCenter Maintenance/Incident currently in progress.
      • COMPLETED - DataCenter Maintenance/Incident is Completed.
      • CANCELLED - DataCenter Maintenance/Incident has been Cancelled.
    • Description - Object - Summary of the ticket from an Equinix Technician.
    • Sequence - Number - Incrementing number for the related notifications. The number starts from 0.
    • StartDateTime - String - Indicates the Start Date and Time of maintenance.
    • EndDateTime - String - Indicates the End Date and Time of maintenance. This value will always be populated for Resource of Type"DataCenter. Maintenance" This value will only be populated for State as COMPLETED for the Resource Types - DataCenter.Incident, DataCenter.SecurityIncident and DataCenter.Advisory.
    • AccountNumber - String - Indicates the Customer's Account Number related to the maintenance activity.
    • Impact - String - Indicates the level/severity of impact to the customer due to the maintenance activity or incident. Supported Values:
      • SERVICE_IMPACTING - indicates the activity or incident that affects your services.
      • NON_SERVICE_IMPACTING - indicates the activity or incident that does not disrupt your services, like when backup servers keep things running despite repairs.
    • ProdID - String - Indicates the link to refer the more information on the maintenance activity.
    • Organizer - String - Indicates the name of maintenance organizer with Email Id. Global Service Desk: cs@equinix.com.
    • Assets - Object - This value will be populated for Resource of Types "DataCenter.Maintenance" and "DataCenter.Incident". An object containing the details of the impacted customer assets with the attributes:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notifications de 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 - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.

    • RequestorId - String - Customer reference number for the maintenance (if any).
    • ServicerId - String - Indicates the unique id supplied by Equinix for the Network maintenance/incident.
    • State - String - Current State of the ticket Supported Values:
      • CONFIRMED - DataCenter Maintenance/Incident is Confirmed.
      • IN-PROCESS - DataCenter Maintenance/Incident currently in progress.
      • COMPLETED - DataCenter Maintenance/Incident is Completed.
      • CANCELLED - DataCenter Maintenance/Incident has been Cancelled.
    • Description - Object - Summary of the ticket from an Equinix Technician.
    • Sequence - Number - Incrementing number for the related notifications. The number starts from 0.
    • StartDateTime - String - Indicates the Start Date and Time of maintenance.
    • EndDateTime - String - Indicates the End Date and Time of maintenance. This value will always be populated for Resource of Type "Network.Maintenance" This value will only be populated for State as COMPLETED for Resource of Type Network.Incident.
    • AccountNumber - String - Indicates the Customer's Account Number related to the maintenance activity.
    • Impact - String - Indicates the level/severity of impact to the customer due to the maintenance activity or incident. Supported Values:
      • SERVICE_IMPACTING - indicates the activity or incident that affects your services.
      • NON_SERVICE_IMPACTING - indicates the activity or incident that does not disrupt your services, like when backup servers keep things running despite repairs.
    • ProdID - String - Indicates the link to refer the more information on the maintenance activity.
    • Organizer - String - Indicates the name of maintenance organizer with Email Id. Global Service Desk: cs@equinix.com.
    • Assets - Object - This value will be populated for Resource of Types "Network.Maintenance" and "Network.Incident". An object containing the details of the impacted customer assets with the attributes:
      • 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 - An object containing the details of the order notification. The attributes within the object will vary based on the resource and state.
    • RequestorId - String - Customer reference number for the order. This is the unique identifier you can provide when placing orders.
    • ServicerId - String - The unique order number supplied by Equinix for the submitted order. Also referred to as the Order Number.
    • ActivityId - String - The unique activity identifier for specific line items or sub-tasks within an order.
    • State - String - The current state of the order. Common states include:
      • Open - Order has been received and is being reviewed
      • InProgress - Work is currently being performed on the order
      • Completed - Order has been successfully completed
      • Cancelled - Order has been cancelled
      • Pending Customer Input - Equinix requires additional information or approval from the customer
      • On Hold - Order is temporarily paused
    • Description - String - A detailed description of the current order status or any messages from Equinix technicians.
    • CustomerContact - String - The primary customer contact email associated with the order.
    • Location - String - The IBX data center location where the order is being fulfilled.
    • ServiceDetails - Object - Details specific to the type of order being performed. Contents vary by order type:
      • 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 - An array of file attachments related to the order. Each attachment includes:
      • Id - Unique identifier for the attachment
      • Name - Filename of the attachment
      • Url - Download URL for the attachment (when available)
Cette page vous a-t-elle été utile ?