Ir 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 pela 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 pedido .

  • ID - String (Guid) - O identificador único da mensagem. A Equinix enviará um valor único para cada mensagem.
  • Source - String (Guid) - Um valor único para identificar o remetente da mensagem. Este valor será compartilhado com o cliente durante o processo de integração.
  • Verb - 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 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 cobrança​

As notificações de faturamento são notificações quase em tempo real, acionadas quando o pedido do cliente é finalizado e A cobrança é iniciada pela Equinix. Essas notificações serão enviadas para todos os pedidos submetidos pelos clientes. por meio de canais offline e online.

Os revendedores também receberão notificações de cobrança quando a cobrança começar 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 cobrança têm os seguintes atributos de corpo:

  • Body - Object - Um objeto contendo os detalhes da notificação. Os atributos dentro do objeto variam de acordo com o recurso e o 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 do Pedido. Valor suportado: 'Fechado'.
    • Description - Object - Resumo do ticket do Sistema de Faturamento.
    • LineDetails - Array - Uma matriz de objetos contendo os detalhes dos itens de linha faturados e o data center:
      • Id - ID exclusivo da linha de faturamento.
      • Ibx - Nome do DataCenter/ IBX.
      • Status - Valor suportado "Faturado".
      • BilledLines - Array[String] Lista de itens faturados

Notificações de Tecido​

O Messaging Gateway oferece suporte a notificações do Fabric para os fluxos de trabalho abaixo:

  • Porta de Equinix Fabric para cima/baixo
  • Conexão virtual do Equinix Fabric ativa/desativada

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 contendo os detalhes da notificação. Os atributos dentro do objeto variam de acordo com o recurso e o verbo.
    • type - String - Indica o tipo de notificação. PORT_OPSTATUS_NOTIFICATION indica que a Porta de Fabric está atualmente em manutenção. CONNECTION_OPSTATUS_NOTIFICATION indica que a Conexão Virtual de Fabric está atualmente em manutenção.
    • uuid - String - Indica o ID exclusivo fornecido pela Equinix para a manutenção.
    • description - String - Resumo do ticket de um técnico da Equinix .
    • data - Object - Um objeto contendo os detalhes da porta do cliente.
      • type - String - Indica o tipo de porta . XF_PORT indica a Porta Equinix Fabric . EVPL_VC indica a conexão virtual Equinix Fabric .
      • uuid - String - Indica o ID único 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 contendo os detalhes relacionados ao status da porta do cliente.
        • operationalStatus - String - Indica o estado atual da porta do cliente.
        • opStatusChangedAt - String - Indica a data e 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 contendo os detalhes das conexões virtuais ativas nesta porta do cliente.
        • connections - Object - Um objeto contendo a lista de conexões virtuais ativas nesta porta do cliente.
          • href - Array[String] - Uma matriz contendo a lista de conexões virtuais ativas nesta porta do cliente.

Notificações IBX​

As notificações do IBX são notificações quase em tempo real para qualquer evento planejado ou não planejado no data center Equinix IBX. manutenção. Essas notificações também são acionadas para quaisquer incidentes no data center Equinix IBX e consultivo.

O Messaging Gateway suporta as seguintes variantes de notificações IBX:

  • Notificações de manutenção do IBX
  • Notificações de incidentes do IBX
  • Notificações de consultoria do 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": "Global Service Desk:mailto:cs@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==  
"  
}

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

  • Body - Object - Um objeto contendo os detalhes da notificação. Os atributos dentro do objeto variam de acordo com o recurso e o 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 - Manutenção/Incidente no Data Center Confirmado.
      • IN-PROCESS - Manutenção/Incidente do DataCenter em andamento.
      • COMPLETED - A manutenção/incidente do DataCenter foi concluída.
      • CANCELLED - A manutenção/incidente do DataCenter foi cancelada.
    • Description - Object - Resumo do ticket de um técnico da Equinix .
    • Sequence - Number - Número incremental para as notificações relacionadas. O número começa em 0.
    • StartDateTime - String - Indica a data e hora de início da manutenção.
    • EndDateTime - String - Indica a data e hora de término da manutenção. Este valor será sempre preenchido para o recurso do tipo "DataCenter. Manutenção". Este valor será preenchido para o estado como COMPLETED apenas para os tipos de recurso - DataCenter.Incident, DataCenter.SecurityIncident e DataCenter.Advisory.
    • AccountNumber - String - Indica o número da conta do cliente relacionada à 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_IMPACTING - indica a atividade ou incidente que não interrompe seus serviços, como quando os servidores de backup mantêm tudo funcionando 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 com endereço de e-mail. Central de Atendimento Global: cs@equinix.com.
    • Assets - Object - Este valor será preenchido para recursos dos tipos "DataCenter.Maintenance" e "DataCenter.Incident". Um objeto contendo os detalhes dos ativos do cliente afetados com os seguintes atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificações de rede​

As notificações de rede são notificações quase em tempo real para qualquer produto Equinix planejado ou não planejado. Manutenção da rede de serviços. Essas notificações também são acionadas para qualquer produto ou serviço da Equinix. Incidentes de rede.

O Messaging Gateway oferece suporte às 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": "Global Service Desk:mailto:cs@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

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

  • Body - Object - Um objeto contendo os detalhes da notificação. Os atributos dentro do objeto variam de acordo com o recurso e o 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 de rede.
    • State - String - Estado atual do ticket. Valores suportados:
      • CONFIRMED - Manutenção/Incidente no Data Center Confirmado.
      • IN-PROCESS - Manutenção/Incidente do DataCenter em andamento.
      • COMPLETED - A manutenção/incidente do DataCenter foi concluída.
      • CANCELLED - A manutenção/incidente do DataCenter foi cancelada.
    • Description - Object - Resumo do ticket de um técnico da Equinix .
    • Sequence - Number - Número incremental para as notificações relacionadas. O número começa em 0.
    • StartDateTime - String - Indica a data e hora de início da manutenção.
    • EndDateTime - String - Indica a data e hora de término da manutenção. Este valor será sempre preenchido para o recurso do tipo "Network.Maintenance". Este valor será preenchido para o estado como COMPLETED apenas para o recurso do tipo Network.Incident.
    • AccountNumber - String - Indica o número da conta do cliente relacionada à 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_IMPACTING - indica a atividade ou incidente que não interrompe seus serviços, como quando os servidores de backup mantêm tudo funcionando 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 com endereço de e-mail. Central de Atendimento Global: cs@equinix.com.
    • Assets - Object - Este valor será preenchido para recursos dos tipos "Network.Maintenance" e "Network.Incident". Um objeto contendo os detalhes dos ativos do cliente afetados com os seguintes atributos:
      • IBX
      • Cage
      • Cabinet
      • Serial Number
      • Circuit Type

Notificações de pedidos​

As notificações de pedidos são notificações quase em tempo real para pedidos feitos através do Portal do Cliente, APIs ou EMG. Essas notificações fornecem atualizações sobre o status dos seus pedidos à medida que eles progridem por várias etapas, incluindo criação, agendamento, atualizações e conclusão.

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

  • Pedidos de conexão cruzada
  • Pedidos da Smart Hands
  • Ordens de visita de trabalho
  • pedidos de envio
  • Pedidos de suporte técnico

Exemplo de Notificação 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=="  
}

As notificações de pedidos possuem os seguintes atributos de corpo:

  • Body - Object - Um objeto contendo os detalhes da notificação do pedido . Os atributos dentro do objeto variam de acordo com o recurso e o estado.
    • RequestorId - String - Número de referência do cliente para o pedido. Este é o identificador único que você pode fornecer ao fazer pedidos.
    • ServicerId - String - O número de pedido exclusivo fornecido pela Equinix para o pedido submetido. Também conhecido como Número do Pedido .
    • ActivityId - String - O identificador de atividade exclusivo para itens de linha ou subtarefas específicos dentro de um pedido.
    • State - String - O estado atual do pedido. Os estados comuns incluem:
      • Open - O Pedido foi recebido e está sendo analisado.
      • InProgress - O trabalho está sendo realizado no pedido.
      • Completed - O Pedido foi concluído com sucesso
      • Cancelled - O Pedido foi cancelado
      • Pending Customer Input - A Equinix requer informações adicionais ou aprovação do cliente.
      • On Hold - O Pedido está temporariamente pausado.
    • Description - String - Uma descrição detalhada do status atual do pedido ou quaisquer mensagens dos técnicos da Equinix .
    • CustomerContact - String - O e-mail de contato principal do cliente associado ao pedido.
    • Location - String - A localização do data center IBX onde o pedido está sendo processado.
    • ServiceDetails - Object - Detalhes específicos do tipo de pedido que está sendo executado. O conteúdo varia de acordo com o tipo de pedido:
      • Para Smart Hands: escopo do trabalho, data e hora de início, data e hora de término, detalhes do equipamento.
      • Para Cross Connect: informações sobre painéis de conexão, detalhes do circuito, tipos de conectores
      • Para visitas a trabalho: informações para visitantes, finalidade, duração.
      • Para envios: informações da transportadora, números de rastreamento, instruções de entrega.
      • Para chamados de suporte: descrição do problema, gravidade, serviços afetados
    • Attachments - Array - Uma matriz de anexos de arquivos relacionados ao pedido. Cada anexo inclui:
      • Id - Identificador único para o anexo
      • Name - Nome do arquivo anexo
      • Url - URL para download do anexo (quando disponível)
Esta página foi útil?