Ir al contenido principal

Tipos de notificaciones

Cada notificación enviada por la Puerta de enlace de mensajería tiene 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 encabezado son aplicables a todos los tipos de orden.

  • ID - String(GUID)` - El identificador único del mensaje. Equinix enviará un valor único para cada mensaje.
  • Source - String(GUID)` - Un valor único para identificar el 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 de 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 body 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 offline y online.

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

Notificación de muestra:

{  
"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 - objeto que contiene los detalles de la notificación. Los atributos dentro del objeto variarán según el 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 de orden. Valor soportado - 'cerrado'.
    • Descripción - Objeto - Resumen del ticket del sistema de facturación.
    • LineDetails - Array - Una matriz de objetos que contiene los detalles de los elementos de línea facturada y el centro de datos:
      • ID - ID único de la línea de facturación.
      • IBX - Nombre del centro de datos/IBX.
      • Estado - Valor soportado "facturado".
      • BilledLines - Array[String] Lista de elementos de línea facturados

Notificaciones de tejido​

La puerta de enlace de mensajería admite notificaciones de tela para los siguientes flujos de trabajo:

  • Equinix Fabric Port arriba / abajo
  • Producto: conexión virtual de Equinix Fabric

Notificación de muestra:

{  
"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 tejido tienen los siguientes atributos del cuerpo:

  • body - object - objeto que contiene los detalles de la notificación. Los atributos dentro del objeto variarán según el recurso y el verbo.
    • type - String - Indica el tipo de notificación. PORT_OPSTATUS_NOTIFICATION indica que el puerto de tela está actualmente en mantenimiento. CONNECTION_OPSTATUS_NOTIFICATION Indicado Fabric Conexión virtual está actualmente en mantenimiento.
    • uuid - String - indica el id ú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 de tela Equinix. 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 el estado del puerto del cliente se monitorizó por última vez.
        • maintenanceMode - Booleano - indica si es 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] - Un array que contiene la lista de las conexiones virtuales activas en este puerto de cliente.

Notificaciones de IBX​

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

Messaging Gateway admite las siguientes variantes de notificaciones IBX:

  • Notificaciones de mantenimiento IBX
  • Notificación de incidentes de IBX
  • Notificaciones de asesoramiento de IBX
  • Notificaciones de incidentes de seguridad IBX

Notificación de muestra:

{  
"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 - objeto que contiene los detalles de la notificación. Los atributos dentro del objeto variarán según el 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 del ticket Valores soportados:
      • CONFIRMADO: Se confirma el mantenimiento/incidente del centro de datos.
      • IN-PROCESS - mantenimiento/incidente del centro de datos actualmente en curso.
      • COMPLETADO - El mantenimiento/incidente del centro de datos se ha completado.
      • CANCELADO - El mantenimiento/incidente del centro de datos ha sido cancelado.
    • Descripción - Objeto - Resumen del ticket de un técnico de Equinix.
    • Sequence - Number - Aumentar el número para las notificaciones relacionadas. El número comienza desde 0.
    • StartDateTime - String - Indica la fecha de inicio y la hora de mantenimiento.
    • EndDateTime - String - Indica la fecha de finalización y la hora de mantenimiento. Este valor siempre será rellenado para Recurso de Tipo"Datacenter. Mantenimiento" Este valor solo se COMPLETARÁ para State como COMPLETADO para los tipos de recursos - datacenter.incident, datacenter.SecurityIncident y datacenter.Advisory.
    • AccountNumber - String - Indica el número de cuenta del Cliente relacionado con la actividad de mantenimiento.
    • Impacto - String - indica el nivel/gravedad del impacto para el cliente debido a la actividad de mantenimiento o incidente. Valores soportados:
      • SERVICE_IMPATING - Indica la actividad o incidente que afecta 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 funcionando a pesar de las reparaciones.
    • ProdID - String - indica el enlace para referirse a más información sobre la actividad de mantenimiento.
    • Organizer - String - Indica el nombre del organizador de mantenimiento. Equinix Soporte al Cliente .
    • Assets - Object - Este valor será rellenado para Recursos de los tipos "datacenter.maintenance" y "datacenter.incident". Un objeto que contiene los detalles de los activos de los clientes afectados 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 producto o mantenimiento de red de servicio de Equinix planificado y no planificado. Estas notificaciones también se activan para cualquier incidente de la red de productos o servicios de Equinix.

Messaging Gateway admite debajo de las variantes de Notificaciones de Red

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

Notificación de muestra:

{  
"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 - objeto que contiene los detalles de la notificación. Los atributos dentro del objeto variarán según el recurso y el verbo.

    • RequestorId - String - Número de referencia del cliente para el mantenimiento (si lo hay).
    • ServicerId - String - Indica el identificador único suministrado por Equinix para el mantenimiento/incidente de la red.
    • State - String - Estado actual del ticket Valores soportados:
      • CONFIRMADO: Se confirma el mantenimiento/incidente del centro de datos.
      • IN-PROCESS - mantenimiento/incidente del centro de datos actualmente en curso.
      • COMPLETADO - El mantenimiento/incidente del centro de datos se ha completado.
      • CANCELADO - El mantenimiento/incidente del centro de datos ha sido cancelado.
    • Descripción - Objeto - Resumen del ticket de un técnico de Equinix.
    • Sequence - Number - Aumentar el número para las notificaciones relacionadas. El número comienza desde 0.
    • StartDateTime - String - Indica la fecha de inicio y la hora de mantenimiento.
    • EndDateTime - String - Indica la fecha de finalización y la hora de mantenimiento. Este valor siempre se llenará para Recurso de tipo "Network.Maintenance" Este valor solo se llenará para Estado como COMPLETADO para el Recurso de tipo Network.Incident.
    • AccountNumber - String - Indica el número de cuenta del Cliente relacionado con la actividad de mantenimiento.
    • Impacto - String - indica el nivel/gravedad del impacto para el cliente debido a la actividad de mantenimiento o incidente. Valores soportados:
      • SERVICE_IMPATING - Indica la actividad o incidente que afecta 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 funcionando a pesar de las reparaciones.
    • ProdID - String - indica el enlace para referirse a más información sobre la actividad de mantenimiento.
    • Organizer - String - Indica el nombre del organizador de mantenimiento. Equinix Soporte al Cliente .
    • Assets - Object - Este valor será rellenado para Recursos de los tipos "Network.Maintenance" y "Network.Incident". Un objeto que contiene los detalles de los activos de los clientes afectados con los atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificaciones de pedidos​

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

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

  • Pedidos Cross Connect
  • Pedido de Smart Hands
  • Órdenes de visita de trabajo
  • ID del pedido de envío
  • Órdenes de boletos de problemas

Notificación de orden de muestra:

{  
"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 pedidos tienen los siguientes atributos de cuerpo:

  • Body - Object - Objeto que contiene los detalles de la notificación de pedido. Los atributos dentro del objeto variarán según el 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 conocido como el número de orden.
    • ActivityId - String - El identificador de actividad único para elementos de línea específicos o subtareas dentro de un orden.
    • State - String - El estado actual de la orden. Los estados comunes incluyen:
      • "Abierto" - Se ha recibido la orden y se está revisando
      • INPROGRESS - Actualmente se está realizando el trabajo por encargo
      • Completado - El pedido se ha completado con éxito
      • CANCELADO - La orden ha sido cancelada
      • Pendiente de entrada del cliente - Equinix requiere información adicional o aprobación por parte del cliente
      • En espera - El orden está temporalmente pausado
    • Description - String - Una 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 con el pedido.
    • Location - String - La ubicación del centro de datos IBX donde se está cumpliendo el pedido.
    • ServiceDetails - Object - Detalles específicos del tipo de orden que se está realizando. El contenido varía según el tipo de orden:
      • Para manos inteligentes: ScopeOfWork, startDateTime, endDateTime, detalles del equipo
      • Para Cross Connect: Información del panel de parches, detalles del circuito, tipos de conectores
      • Para la visita de trabajo: Información del visitante, propósito, duración
      • Para envíos: Información del transportista, números de seguimiento, instrucciones de entrega
      • Para tickets de problemas: Descripción del problema, gravedad, servicios afectados
    • Adjuntos - Array - Un array de archivos adjuntos relacionados con el orden. Cada adjunto incluye:
      • ID - identificador único para el archivo adjunto
      • Name - Nombre de archivo del archivo adjunto
      • URL - Descargar URL para el archivo adjunto (cuando esté disponible)
¿Fue útil esta página?