Pular para o conteúdo principal

Tipos de notificação

Cada notificação enviada pelo Messaging Gateway tem um formato comum, dependendo do tipo de notificação. A estrutura da mensagem de notificação também é descrita na documentação da AsyncAPI .

Todas as mensagens enviadas da Equinix têm os seguintes 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"  
}

Esses atributos de cabeçalho são aplicáveis a todos os tipos de ordem.

  • "ID" - "String" "(Guid)" - o identificador exclusivo da mensagem. A Equinix enviará um valor exclusivo para cada mensagem.
  • "Source" - "String" "(Guid)" - Um valor exclusivo para identificar o remetente da mensagem. Esse valor será compartilhado com o cliente durante o processo de integração.
  • 'Verbo' - 'String' - Atualização. Isso indica que há uma atualização da Equinix.
  • 'Resource' - 'String' - Nome do produto Equinix para o qual a notificação está sendo enviada.
  • "ContentType" - "String" - "Application/json"
  • 'CreateTimeUTC' - 'String' - Indica a data e a hora em que a notificação é enviada pela Equinix.
  • "Version" - "String" - A versão do esquema de notificação.

Os atributos do corpo variam para cada tipo de notificação.

Notificações de faturamento​

As notificações de faturamento são notificações quase em tempo real acionadas quando o pedido do cliente é fechado e o faturamento é iniciado pela Equinix. Essas notificações serão acionadas para todos os pedidos de clientes enviados por meio de canais off-line e on-line.

Os revendedores também receberão notificações de faturamento quando o faturamento for iniciado para pedidos feitos pelos clientes.

Notificação de amostra:

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

As notificações de faturamento têm os seguintes atributos de corpo:

  • "Body" - "Object" - um objeto que contém os detalhes da notificação. Os atributos dentro do objeto irão variar com base no recurso e verbo.
    • "RequestorId" - "String" - Número de referência do cliente para a manutenção (se houver).
    • "ServicerId" - "String" - indica o ID exclusivo fornecido pela Equinix para o pedido enviado.
    • "State" - "String" - indica o estado atual da ordem. Valor suportado - 'Fechado'.
    • "Description" - "Object" - Resumo do tíquete do sistema de faturamento.
    • 'LineDetails' - 'Array' - um array de objeto contendo os detalhes dos itens de linha faturados e do data center:
      • 'ID' - ID de linha de faturamento exclusivo.
      • 'IBX' - nome do data center/IBX.
      • "Status" - Valor suportado "faturado".
      • 'BilledLines' - 'Array[String]' Lista de itens de linha faturados

Notificações de malha​

O Messaging Gateway oferece suporte a Notificações de malha para os fluxos de trabalho abaixo:

  • Porta ou conexão do Equinix Fabric
  • Produto de Conexão Virtual do Equinix Fabric

Notificação de amostra:

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

As notificações de fabric têm os seguintes atributos de corpo:

  • "Body" - "Object" - um objeto que contém os detalhes da notificação. Os atributos dentro do objeto irão variar com base no recurso e verbo.
    • "Type" - "String" - indica o tipo de notificação. "PORT_OPSTATUS_NOTIFICATION" indica que a porta do fabric está em manutenção no momento. "CONNECTION_OPSTATUS_NOTIFICATION" indicou que a conexão virtual da malha está em manutenção no momento.
    • 'uuid' - 'String' - indica o ID exclusivo fornecido pela Equinix para a manutenção.
    • "Descrição" - "String" - Resumo do tíquete de um técnico da Equinix.
    • "Data" - "Object" - um objeto que contém os detalhes da porta do cliente.
      • 'Type' - 'String' - indica o tipo de porta. "XF_PORT" indica Equinix Fabric Port. "EVPL_VC" indica Equinix Fabric Virtual Connection.
      • "uuid" - "String" - indica o ID exclusivo da porta do cliente.
      • "Name" - "String" - indica o nome da porta do cliente.
      • 'Href' - 'String' - Link para obter mais detalhes da porta do cliente.
      • "Operation" - "Object" - um objeto que contém os detalhes relacionados ao status da porta do cliente.
        • "OperationalStatus" - "String" - indica o status atual da porta do cliente.
        • 'OpStatusChangedAt' - 'String' - indica a data e a hora em que o status da porta do cliente foi monitorado pela última vez.
        • "MaintenanceMode" - "Boolean" - indica se é uma manutenção planejada ou não planejada.
      • "Embedded" - "Object" - um objeto que contém os detalhes das conexões virtuais ativas nesta porta do cliente.
        • "Connections" - "Object" - um objeto que contém a lista de conexões virtuais ativas nesta porta do cliente.
          • 'Href' - 'Array[String]' - um array contendo a lista de conexões virtuais ativas nesta porta do cliente.

Notificações do IBX​

As Notificações IBX são notificações quase em tempo real para qualquer manutenção planejada e não planejada do data center IBX da Equinix. Essas notificações também são acionadas para quaisquer incidentes e consultoria de data center IBX da Equinix.

O Messaging Gateway é compatível com as seguintes variantes de notificações IBX:

  • Notificações de manutenção IBX
  • Notificações de incidentes IBX
  • Notificações de aviso IBX
  • Notificações de Incidentes de Segurança IBX

Notificação de amostra:

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

As notificações IBX têm os seguintes atributos de corpo:

  • "Body" - "Object" - um objeto que contém os detalhes da notificação. Os atributos dentro do objeto irão variar com base no recurso e verbo.
    • "RequestorId" - "String" - Número de referência do cliente para a manutenção (se houver).
    • "ServicerId" - "String" - indica o ID exclusivo fornecido pela Equinix para a manutenção/incidente do datacenter.
    • 'State' - 'String' - Estado atual do ticket Valores suportados:
      • "CONFIRMED" (CONFIRMADO) - A manutenção/incidente do data center foi confirmada.
      • "EM PROCESSO" - Manutenção/incidente do data center em andamento.
      • "COMPLETED" (CONCLUÍDO) - a manutenção/incidente do data center foi concluída.
      • "CANCELADO" - A manutenção/incidente do data center foi cancelada.
    • "Description" - "Object" - Resumo do tíquete de um técnico da Equinix.
    • "Sequence" - "Number" - número incrementado para as notificações relacionadas. O número começa em 0.
    • 'StartDateTime' - 'String' - Indica a data e a hora de início da manutenção.
    • "EndDateTime" - "String" - indica a data e a hora finais da manutenção. Este valor será sempre preenchido para Recurso do tipo "datacenter. Maintenance" (Manutenção) Este valor será preenchido somente para o Estado como "COMPLETED" (CONCLUÍDO) para os Tipos de Recurso - "DataCenter.Incident", "DataCenter.SecurityIncident" e "DataCenter.Advisory".
    • "AccountNumber" - "String" - indica o número da conta do Cliente relacionado à atividade de manutenção.
    • "Impact" - "String" - indica o nível/gravidade do impacto para o cliente devido à atividade de manutenção ou incidente. Valores suportados:
      • "SERVICE_IMPACTING" - Indica a atividade ou incidente que afeta seus serviços.
      • 'NON_SERVICE_IMPACTAING' - Indica a atividade ou incidente que não interrompe seus serviços, como quando os servidores de backup mantêm as coisas em execução apesar dos reparos.
    • "ProdID" - "String" - indica o link para consultar mais informações sobre a atividade de manutenção.
    • 'Organizer' - 'String' - indica o nome do organizador de manutenção. Suporte ao Cliente Equinix .
    • "Assets" - "Object" - Este valor será preenchido para Recursos dos tipos "DataCenter.Maintenance" e "DataCenter.Incident". Um objeto contendo os detalhes dos ativos afetados do cliente com os atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificações de rede​

Notificações de rede são notificações quase em tempo real para qualquer manutenção planejada e não planejada da Rede de Produtos ou Serviços Equinix. Essas notificações também são acionadas para quaisquer incidentes da Rede de Produtos ou Serviços Equinix.

O Messaging Gateway é compatível com as variantes de Notificações de rede abaixo

  • Notificações de manutenção de rede
  • Notificações de incidentes de rede

Notificação de amostra:

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

As notificações de rede têm os seguintes atributos de corpo:

  • "Body" - "Object" - um objeto que contém os detalhes da notificação. Os atributos dentro do objeto irão variar com base no recurso e verbo.

    • "RequestorId" - "String" - Número de referência do cliente para a manutenção (se houver).
    • "ServicerId" - "String" - indica o ID exclusivo fornecido pela Equinix para a manutenção/incidente da rede.
    • 'State' - 'String' - Estado atual do ticket Valores suportados:
      • "CONFIRMED" (CONFIRMADO) - A manutenção/incidente do data center foi confirmada.
      • "EM PROCESSO" - Manutenção/incidente do data center em andamento.
      • "COMPLETED" (CONCLUÍDO) - a manutenção/incidente do data center foi concluída.
      • "CANCELADO" - A manutenção/incidente do data center foi cancelada.
    • "Description" - "Object" - Resumo do tíquete de um técnico da Equinix.
    • "Sequence" - "Number" - número incrementado para as notificações relacionadas. O número começa em 0.
    • 'StartDateTime' - 'String' - Indica a data e a hora de início da manutenção.
    • "EndDateTime" - "String" - indica a data e a hora finais da manutenção. Este valor será sempre preenchido para Recurso do tipo "Network.Maintenance" Este valor será preenchido apenas para Estado como "CONCLUÍDO" para Recurso do tipo "Network.Incident".
    • "AccountNumber" - "String" - indica o número da conta do Cliente relacionado à atividade de manutenção.
    • "Impact" - "String" - indica o nível/gravidade do impacto para o cliente devido à atividade de manutenção ou incidente. Valores suportados:
      • "SERVICE_IMPACTING" - Indica a atividade ou incidente que afeta seus serviços.
      • 'NON_SERVICE_IMPACTAING' - Indica a atividade ou incidente que não interrompe seus serviços, como quando os servidores de backup mantêm as coisas em execução apesar dos reparos.
    • "ProdID" - "String" - indica o link para consultar mais informações sobre a atividade de manutenção.
    • 'Organizer' - 'String' - indica o nome do organizador de manutenção. Suporte ao Cliente Equinix .
    • "Assets" - "Object" - Este valor será preenchido para Recursos dos tipos "Network.Maintenance" e "Network.Incident". Um objeto contendo os detalhes dos ativos afetados do cliente com os atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificação de pedidos​

Notificações de pedidos são notificações quase em tempo real para pedidos feitos por meio do Portal do Cliente, APIs ou EMG. Essas notificações fornecem atualizações sobre o status de seus pedidos à medida que eles progridem em vários estágios, incluindo criação, agendamento, atualizações e conclusão.

As notificações de pedido estão disponíveis para os seguintes tipos de pedido:

  • Pedido de Cross Connect
  • Pedido Smart Hands
  • Ordens de visita de trabalho
  • ID da ordem da remessa
  • Pedidos de Tíquetes de Problemas

Notificação de pedido de amostra:

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

As notificações de pedido têm os seguintes atributos de corpo:

  • "Body" - "Object" - um objeto que contém os detalhes da notificação do pedido. Os atributos dentro do objeto variarão com base no recurso e no estado.
    • "RequestorId" - "String" - Número de referência do cliente para o pedido. Este é o identificador exclusivo que você pode fornecer ao fazer pedidos.
    • "ServicerId" - "String" - O número exclusivo do pedido fornecido pela Equinix para o pedido enviado. Também conhecido como número do pedido.
    • "ActivityId" - "String" - o identificador exclusivo de atividade para itens de linha ou subtarefas específicos em um pedido.
    • "State" - "String" - O estado atual do pedido. os estados comuns incluem:
      • "Aberto" - o pedido foi recebido e está sendo revisado
      • "Em andamento" - o trabalho está sendo executado no pedido
      • "Completed" - O pedido foi concluído com sucesso
      • 'Cancelado' - o pedido foi cancelado
      • "Entrada pendente do cliente" - A Equinix requer informações adicionais ou aprovação do cliente
      • "Em espera" - o pedido está temporariamente pausado
    • "Description" - "String" - Uma descrição detalhada do status atual do pedido ou de quaisquer mensagens dos técnicos da Equinix.
    • "CustomerContact" - "String" - O e-mail de contato principal do cliente associado ao pedido.
    • "Location" - "String" - o local do data center IBX onde o pedido está sendo atendido.
    • "ServiceDetails" - "Object" - Detalhes específicos para o tipo de ordem que está sendo executada. O conteúdo varia de acordo com o tipo de pedido:
      • Para Smart Hands: ScopeOfWork, startDateTime, endDateTime, detalhes do equipamento
      • Para Cross Connect: Informação do painel de remendo, detalhes do circuito, tipos do conetor
      • Para visita de trabalho: Informações do visitante, finalidade, duração
      • Para remessas: Informações da transportadora, números de rastreamento, instruções de entrega
      • Para tickets de problemas: Descrição do problema, gravidade, serviços afetados
    • "Attachments" - "Array" - uma matriz de anexos de arquivo relacionados ao pedido. Cada anexo inclui:
      • "ID" - identificador exclusivo do anexo
      • 'Name' - nome do arquivo do anexo
      • 'URL' - URL de download para o anexo (quando disponível)
Esta página foi útil?