Saltar al contenido principal

Tipos de notificación

Todas las notificaciones enviadas por Messaging Gateway tienen un formato común, dependiendo del tipo de notificación. La estructura del mensaje de notificación también se describe en la documentación de AsyncAPI .

Todos los mensajes salientes de Equinix tienen los siguientes componentes:

{  
"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"  
}

Estos atributos de cabecera son aplicables a todos los tipos de pedido.

  • ID - String (Guid) - El identificador único del mensaje. Equinix enviará un valor único para cada mensaje.
  • Source - String (Guid) - Un valor único para identificar al remitente del mensaje. Este valor se compartirá con el cliente durante el proceso de incorporación.
  • Verb - String - Actualización. Esto indica que hay una actualización de Equinix.
  • Resource - String - Nombre del producto Equinix para el que se está enviando la notificación.
  • ContentType - String - "aplicación/json"
  • CreateTimeUTC - String - Indica la fecha y hora en la que Equinix envía la notificación.
  • Version - String - La versión del esquema de notificación.

Los atributos del cuerpo varían para cada tipo de notificación.

Notificaciones de facturación​

Las notificaciones de facturación son notificaciones casi en tiempo real que se activan cuando el pedido del cliente se cierra y Equinix inicia la facturación. Estas notificaciones se activarán para todos los pedidos de los clientes enviados a través de canales tanto offline como online.

Los revendedores también recibirán notificaciones de facturación cuando se inicie la facturación de los pedidos realizados por los clientes.

Muestra de notificación:

{  
"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=="  
}

Las notificaciones de facturación tienen los siguientes atributos de cuerpo:

  • Body - Object - Un objeto que contiene los detalles de la notificación. Los atributos dentro del objeto variarán en función del recurso y el verbo.
    • RequestorId - String - Número de referencia del cliente para el mantenimiento (si lo hay).
    • ServicerId - String - Indica el ID único suministrado por Equinix para el pedido enviado.
    • State - String - Indica el estado actual del pedido. Valor admitido - "Cerrado".
    • Description - Object - Resumen del ticket del sistema de facturación.
    • LineDetails - Array - Una matriz de objetos que contiene los detalles de los elementos de la línea facturada y el centro de datos:
      • Id - ID de línea de facturación único.
      • Ibx - Nombre del centro de datos/IBX.
      • Status - Valor admitido "Facturado".
      • BilledLines - Array[String] Lista de artículos de línea facturados

Notificaciones de Fabric​

Messaging Gateway admite notificaciones Fabric para los siguientes flujos de trabajo:

  • Puerto Equinix Fabric Arriba/Abajo
  • Conexión virtual Equinix Fabric Arriba/Abajo

Muestra de notificación:

{  
"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=="  
}

Las notificaciones de Fabric tienen los siguientes atributos:

  • Body - Object - Un objeto que contiene los detalles de la notificación. Los atributos dentro del objeto variarán en función del recurso y el verbo.
    • type - String - Indica el tipo de notificación. PORT_OPSTATUS_NOTIFICATION Indica que el puerto de Fabric está actualmente en mantenimiento. CONNECTION_OPSTATUS_NOTIFICATION La conexión virtual de Fabric indicada se encuentra actualmente en mantenimiento.
    • uuid - String - Indica el ID único suministrado por Equinix para el mantenimiento.
    • description - String - Resumen de la solicitud de un técnico de Equinix.
    • data - Object - Un objeto que contiene los detalles del puerto del cliente.
      • type - String - Indica el tipo de puerto. XF_PORT Indica el puerto de Equinix Fabric. EVPL_VC Indica la conexión virtual de Equinix Fabric.
      • uuid - String - Indica el ID único del puerto del cliente.
      • name - String - Indica el nombre del puerto del cliente.
      • href - String - Enlace para obtener más detalles del puerto del cliente.
      • operation - Object - Un objeto que contiene los detalles relacionados con el estado del puerto del cliente.
        • operationalStatus - String - Indica el estado actual del puerto del cliente.
        • opStatusChangedAt - String - Indica la fecha y hora en la que se monitorizó por última vez el estado del puerto del cliente.
        • maintenanceMode - Boolean - Indica si se trata de un mantenimiento planificado o no planificado.
      • embedded - Object - Un objeto que contiene los detalles de las conexiones virtuales activas en este puerto de cliente.
        • connections - Object - Un objeto que contiene la lista de las conexiones virtuales activas en este puerto de cliente.
          • href - Array[String] - Una matriz que contiene la lista de las conexiones virtuales activas en este puerto de cliente.

Notificaciones de IBX​

Las notificaciones de IBX son notificaciones casi en tiempo real para cualquier mantenimiento planificado y no planificado del centro de datos Equinix IBX. Estas notificaciones también se activan para cualquier incidente de data center Equinix IBX y asesoramiento.

Messaging Gateway admite las siguientes variantes de notificaciones IBX:

  • Notificaciones de mantenimiento de IBX
  • Notificaciones de incidentes IBX
  • Avisos de IBX
  • Notificaciones de incidentes de seguridad de IBX

Muestra de notificación:

{  
"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==  
"  
}

Las notificaciones IBX tienen los siguientes atributos de cuerpo:

  • Body - Object - Un objeto que contiene los detalles de la notificación. Los atributos dentro del objeto variarán en función del recurso y el verbo.
    • RequestorId - String - Número de referencia del cliente para el mantenimiento (si lo hay).
    • ServicerId - String - Indica el ID único suministrado por Equinix para el mantenimiento/incidente del centro de datos.
    • State - String - Estado actual de los valores admitidos por ticket:
      • CONFIRMED - Se confirma el mantenimiento/incidente del centro de datos.
      • IN-PROCESS - Mantenimiento/incidente del centro de datos actualmente en curso.
      • COMPLETED - Se ha completado el mantenimiento/incidente del centro de datos.
      • CANCELLED - Se ha cancelado el mantenimiento/incidente del centro de datos.
    • Description - Object - Resumen de la solicitud de un técnico de Equinix.
    • Sequence - Number - Aumentar el número de las notificaciones relacionadas. El número comienza desde 0.
    • StartDateTime - String - Indica la fecha de inicio y la hora del mantenimiento.
    • EndDateTime - String - Indica la fecha de finalización y la hora del mantenimiento. Este valor siempre se rellenará para Recurso de tipo"centro de datos. Mantenimiento" Este valor solo se rellenará para State como COMPLETED para los tipos de recursos - DataCenter.Incident, DataCenter.SecurityIncident y DataCenter.Advisory.
    • AccountNumber - StringIndica el número de cuenta del Cliente relacionado con la actividad de mantenimiento.
    • Impact - StringIndica el nivel/gravedad del impacto para el cliente debido a la actividad de mantenimiento o incidente. Valores admitidos:
      • SERVICE_IMPACTING - indica la actividad o incidencia que afecta a sus servicios.
      • NON_SERVICE_IMPACTING - indica la actividad o incidente que no interrumpe sus servicios, como cuando los servidores de copia de seguridad mantienen las cosas en funcionamiento a pesar de las reparaciones.
    • ProdID - String - Indica el enlace para consultar más información sobre la actividad de mantenimiento.
    • Organizer - String - Indica el nombre del organizador de mantenimiento. Atención al cliente de Equinix .
    • Assets - Object - Este valor se rellenará para el recurso de los tipos "datacenter.Maintenance" y "datacenter.Incident". Un objeto que contiene los detalles de los activos del cliente afectados con los atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificaciones de red​

Las notificaciones de red son notificaciones casi en tiempo real de cualquier producto o servicio de Equinix planificado o no planificado de mantenimiento de red. Estas notificaciones también se activan para cualquier incidente de red de productos o servicios de Equinix.

Messaging Gateway admite las siguientes variantes de notificaciones de red

  • Notificaciones de mantenimiento de la red
  • Notificaciones de incidentes en la red

Muestra de notificación:

{  
"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=="  
}

Las notificaciones de red tienen los siguientes atributos de cuerpo:

  • Body - Object - Un objeto que contiene los detalles de la notificación. Los atributos dentro del objeto variarán en función del recurso y el verbo.

    • RequestorId - String - Número de referencia del cliente para el mantenimiento (si lo hay).
    • ServicerId - String - Indica el ID único suministrado por Equinix para el Mantenimiento de la red/Incidente.
    • State - String - Estado actual de los valores admitidos por ticket:
      • CONFIRMED - Se confirma el mantenimiento/incidente del centro de datos.
      • IN-PROCESS - Mantenimiento/incidente del centro de datos actualmente en curso.
      • COMPLETED - Se ha completado el mantenimiento/incidente del centro de datos.
      • CANCELLED - Se ha cancelado el mantenimiento/incidente del centro de datos.
    • Description - Object - Resumen de la solicitud de un técnico de Equinix.
    • Sequence - Number - Aumentar el número de las notificaciones relacionadas. El número comienza desde 0.
    • StartDateTime - String - Indica la fecha de inicio y la hora del mantenimiento.
    • EndDateTime - String - Indica la fecha de finalización y la hora del mantenimiento. Este valor siempre se rellenará para el recurso del tipo "Red.Mantenimiento" Este valor solo se rellenará para el estado como COMPLETED para el recurso del tipo Network.Incident.
    • AccountNumber - StringIndica el número de cuenta del Cliente relacionado con la actividad de mantenimiento.
    • Impact - StringIndica el nivel/gravedad del impacto para el cliente debido a la actividad de mantenimiento o incidente. Valores admitidos:
      • SERVICE_IMPACTING - indica la actividad o incidencia que afecta a sus servicios.
      • NON_SERVICE_IMPACTING - indica la actividad o incidente que no interrumpe sus servicios, como cuando los servidores de copia de seguridad mantienen las cosas en funcionamiento a pesar de las reparaciones.
    • ProdID - String - Indica el enlace para consultar más información sobre la actividad de mantenimiento.
    • Organizer - String - Indica el nombre del organizador de mantenimiento. Atención al cliente de Equinix .
    • Assets - Object - Este valor se rellenará para el recurso de los tipos "Network.Maintenance" y "Network.Incident". Un objeto que contiene los detalles de los activos del cliente afectados con los atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificaciones de pedidos​

Las notificaciones de pedidos son notificaciones casi en tiempo real de los pedidos realizados a través del portal del cliente, las API o el EMG. Estas notificaciones proporcionan actualizaciones sobre el estado de sus pedidos a medida que avanzan en varias etapas, incluida la creación, la programación, las actualizaciones y la finalización.

Las notificaciones de pedido están disponibles para los siguientes tipos de pedido:

  • Pedidos Cross Connects
  • Pedidos de Smart Hands
  • Órdenes de visita de trabajo
  • Pedidos de envío
  • Pedidos de Trouble Ticket

Ejemplo de notificación de pedido:

{  
"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=="  
}

Las notificaciones de pedido tienen los siguientes atributos de cuerpo:

  • Body - Object - Un objeto que contiene los detalles de la notificación de pedido. Los atributos dentro del objeto variarán en función del recurso y el estado.
    • RequestorId - String - Número de referencia del cliente para el pedido. Este es el identificador único que puede proporcionar al realizar pedidos.
    • ServicerId - String - El número de pedido único suministrado por Equinix para el pedido enviado. También denominado número de pedido.
    • ActivityId - String - El identificador de actividad único para artículos de línea o subtareas específicas dentro de un pedido.
    • State - String - El estado actual del pedido. Los estados comunes incluyen:
      • Open - El pedido se ha recibido y se está revisando
      • InProgress - Actualmente se está realizando el trabajo en el pedido
      • Completed - El pedido se ha completado correctamente
      • Cancelled - El pedido se ha cancelado
      • Pending Customer Input - Equinix requiere información adicional o aprobación del cliente
      • On Hold - El pedido se ha pausado temporalmente
    • Description - StringUna descripción detallada del estado actual del pedido o de cualquier mensaje de los técnicos de Equinix.
    • CustomerContact - String - El correo electrónico de contacto principal del cliente asociado al pedido.
    • Location - String - La ubicación del centro de datos IBX donde se está cumplimentando el pedido.
    • ServiceDetails - Object - Detalles específicos del tipo de pedido que se está realizando. El contenido varía según el tipo de pedido:
      • Para Smart Hands: scopeOfWork, startDateTime, endDateTime, detalles del equipo
      • Para Cross Connect: información sobre paneles de conexiones, detalles de circuitos, tipos de conectores
      • Visita de trabajo: información del visitante, propósito, duración
      • Para envíos: información sobre el transportista, números de seguimiento, instrucciones de entrega
      • Para Trouble Tickets: descripción del problema, gravedad, servicios afectados
    • Attachments - Array - Un conjunto de archivos adjuntos relacionados con el pedido. Cada archivo adjunto incluye:
      • Id - Identificador único para el archivo adjunto
      • Name - Nombre del archivo adjunto
      • Url - Descargar URL para el archivo adjunto (cuando esté disponible)
¿Le ha resultado útil esta página?