Ir al contenido principal

Tipos de notificación

Cada notificación enviada por el Messaging Gateway tiene un formato común, dependiendo del tipo de notificación. La estructura de los mensajes 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 envía la notificación.
  • ContentType - String - "application/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 se cierra el pedido del cliente y Equinix inicia la facturación. Estas notificaciones se activarán para todos los pedidos de 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 del verbo.
    • RequestorId - String - Número de referencia del cliente para el mantenimiento (si existe).
    • ServicerId - String - Indica el identificador ú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 las partidas facturadas y del centro de datos:
      • Id - ID único de línea de facturación.
      • Ibx - Nombre del centro de datos/IBX.
      • Status - Valor admitido "Facturado".
      • BilledLines - Array[String] Lista de partidas facturadas

Notificaciones de tejidos​

El Gateway de mensajería admite notificaciones de 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 del verbo.
    • type - String - Indica el tipo de notificación. PORT_OPSTATUS_NOTIFICATION Indica que Fabric Port está actualmente en mantenimiento. CONNECTION_OPSTATUS_NOTIFICATION Indica que Fabric Virtual Connection está actualmente en mantenimiento.
    • uuid - String - Indica el identificador único suministrado por Equinix para el mantenimiento.
    • description - String - Resumen del ticket 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 Equinix Fabric. EVPL_VC Indica conexión virtual Equinix Fabric.
      • uuid - String - Indica el identificador único del puerto del cliente.
      • name - String - Indica el nombre del puerto del cliente.
      • href - String - Enlace para obtener más detalles del puerto de clientes.
      • 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 supervisó por última vez el estado del puerto del cliente.
        • maintenanceMode - Boolean - Indica si se trata de un mantenimiento planificado o no planificado.
      • embedded - Object - Objeto que contiene los detalles de las conexiones virtuales activas en este puerto de cliente.
        • connections - Object - 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 IBX​

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

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": "Global Service Desk:mailto:cs@equinix.com",  
    "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 del verbo.
    • RequestorId - String - Número de referencia del cliente para el mantenimiento (si existe).
    • ServicerId - String - Indica el identificador único suministrado por Equinix para el mantenimiento/incidente del centro de datos.
    • State - String - Estado actual de la entrada Valores admitidos:
      • CONFIRMED - Se confirma mantenimiento/incidente en el centro de datos.
      • IN-PROCESS - Mantenimiento/Incidente del centro de datos en curso.
      • COMPLETED - El mantenimiento/incidente del centro de datos ha finalizado.
      • CANCELLED - El mantenimiento/incidente del centro de datos ha sido cancelado.
    • Description - Object - Resumen del ticket de un técnico de Equinix.
    • Sequence - Number - Número incremental para las notificaciones relacionadas. El número empieza por 0.
    • StartDateTime - String - Indica la fecha y hora de inicio del mantenimiento.
    • EndDateTime - String - Indica la Fecha y Hora de finalización del mantenimiento. Este valor se rellenará siempre para el Recurso de Tipo "DataCenter. Mantenimiento" Este valor sólo se poblará para el Estado como COMPLETED para los Tipos de Recurso - DataCenter.Incident, DataCenter.SecurityIncident y DataCenter.Advisory.
    • AccountNumber - String - Indica el número de cuenta del cliente relacionado con la actividad de mantenimiento.
    • Impact - String - Indica el nivel/severidad 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 el incidente que no interrumpe sus servicios, como cuando los servidores de respaldo 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 del mantenimiento con el Id. de correo electrónico. Global Service Desk: cs@equinix.com.
    • Assets - Object - Este valor se rellenará para los recursos de tipo "Centro de Datos.Mantenimiento" y "Centro de Datos.Incidente". Un objeto que contiene los detalles de los activos del cliente impactados con los atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificaciones de red​

Las notificaciones de red son notificaciones casi en tiempo real para cualquier mantenimiento planificado y no planificado de la red de productos o servicios de Equinix. Estas notificaciones también se activan para cualquier incidente de la Red de Productos o Servicios 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": "Global Service Desk:mailto:cs@equinix.com",  
    "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 del verbo.

    • RequestorId - String - Número de referencia del cliente para el mantenimiento (si existe).
    • ServicerId - String - Indica el identificador único suministrado por Equinix para el mantenimiento/incidente de la red.
    • State - String - Estado actual de la entrada Valores admitidos:
      • CONFIRMED - Se confirma mantenimiento/incidente en el centro de datos.
      • IN-PROCESS - Mantenimiento/Incidente del centro de datos en curso.
      • COMPLETED - El mantenimiento/incidente del centro de datos ha finalizado.
      • CANCELLED - El mantenimiento/incidente del centro de datos ha sido cancelado.
    • Description - Object - Resumen del ticket de un técnico de Equinix.
    • Sequence - Number - Número incremental para las notificaciones relacionadas. El número empieza por 0.
    • StartDateTime - String - Indica la fecha y hora de inicio del mantenimiento.
    • EndDateTime - String - Indica la Fecha y Hora de finalización del mantenimiento. Este valor se rellenará siempre para el Recurso de Tipo "Red.Mantenimiento" Este valor sólo se rellenará para el Estado como COMPLETED para el Recurso de Tipo Network.Incident.
    • AccountNumber - String - Indica el número de cuenta del cliente relacionado con la actividad de mantenimiento.
    • Impact - String - Indica el nivel/severidad 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 el incidente que no interrumpe sus servicios, como cuando los servidores de respaldo 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 del mantenimiento con el Id. de correo electrónico. Global Service Desk: cs@equinix.com.
    • Assets - Object - Este valor se rellenará para los recursos de tipo "Red.Mantenimiento" y "Red.Incidente". Un objeto que contiene los detalles de los activos del cliente impactados con los atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificaciones de pedidos​

Las notificaciones de pedido son notificaciones casi en tiempo real de los pedidos realizados a través del Portal del cliente, las API o EMG. Estas notificaciones proporcionan actualizaciones sobre el estado de sus pedidos a medida que progresan a través de varias etapas, incluyendo la creación, programación, actualizaciones y 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 del pedido. Los atributos dentro del objeto variarán en función del recurso y del estado.
    • RequestorId - String - Número de referencia del cliente para el pedido. Es el identificador único que puede proporcionar al realizar pedidos.
    • ServicerId - String - El número de pedido único proporcionado por Equinix para el pedido enviado. También denominado número de pedido.
    • ActivityId - String - El identificador único de actividad para partidas o subtareas específicas dentro de un pedido.
    • State - String - El estado actual del pedido. Los estados comunes incluyen:
      • Open - Se ha recibido el pedido y se está revisando
      • InProgress - Se está trabajando actualmente en el pedido
      • Completed - El pedido se ha completado con éxito
      • Cancelled - El pedido ha sido cancelado
      • Pending Customer Input - Equinix requiere información adicional o la aprobación del cliente
      • On Hold - El pedido está temporalmente en pausa
    • Description - String - Una descripción detallada del estado actual del pedido o 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 - Una serie de archivos adjuntos relacionados con el pedido. Cada archivo adjunto incluye:
      • Id - Identificador único para el archivo adjunto
      • Name - Nombre del archivo adjunto
      • Url - URL de descarga del archivo adjunto (cuando esté disponible)
¿Fue útil esta página?