Enviando eventos para a instância usando a API de serviço da Web

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 5 min. de leitura
  • Você pode usar uma interface de serviço web, compatível com ServiceNow, Que opera no objeto JSON como o formato de entrada e saída de dados.

    Antes de Iniciar

    Função necessária: evt_mgmt_integration

    Por Que e Quando Desempenhar Esta Tarefa

    Para inserir registros na tabela Evento [em_event] com uma única chamada, use esta API de serviço web:

    https://<instancename>.service-now.com/api/global/em/jsonv2

    Nota:
    As regras de negócio na tabela de eventos não são invocadas quando esta URL é usada.

    Não adicione campos adicionais a um evento adicionando um campo personalizado à tabela de eventos [em_event]. No entanto, campos adicionais devem ser incluídos em Informações adicionais campo [additional_info] do evento. Para obter mais informações sobre como incluir campos adicionais em eventos, consulte Campos de alerta personalizados.

    O URL no formato: http://<instancename>.service-now.com/em_event.do?JSONv2&sysparm_action=insertMultiple Também é compatível caso você queira ativar Regras de negócios. No entanto, o desempenho da primeira URL é superior.

    Para trabalhar com o URL que termina com InsertMultiple , Adicione as seguintes propriedades, com seus respectivos valores, ao MID Server:
    • "mid.probe.event.queue.compress" - valor: falso
    • "mid.probe.event.bulk_size" - valor: 100
    • "mid.probe.event.endpoint.url" - Valor: Em_event.do?JSONv2%26sysparm_action

    Procedimento

    1. Envie a solicitação com estes cabeçalhos:
      Parâmetro Tipo Descrição
      Aceitar Cadeia de caracteres O tipo aceitável para esta mensagem.

      O valor padrão é aplicação/json .

      Tipo de conteúdo Cadeia de caracteres O tipo de conteúdo desta mensagem.

      O valor padrão é aplicação/json .

      POST Cadeia de caracteres O tipo de solicitação é POST, com um ou mais registros finais.
    2. Um ou mais eventos no formato JSON podem ser enviados como a carga da chamada de serviço web.
      Os campos de evento que devem ser preenchidos são:
      Variável Descrição
      origem O nome do tipo de origem do evento. Por exemplo, SCOM ou SolarWinds.
      event_class Instância específica do source. Por exemplo, SCOM 2012 em 10.20.30.40
      node . O campo deve conter um identificador para o Host (Servidor/Switch/Roteador/etc.) para o qual o evento foi acionado. O valor de O campo pode ser um dos seguintes identificadores do Host:
      • Nome
      • FQDN
      • IP
      • Endereço Mac
      Se ele existir no CMDB, esse valor também será usado para vincular o evento ao IC da ServiceNow correspondente.
      recurso Se o evento se referir a um dispositivo, como Disco, CPU ou Adaptador de rede, ou para uma aplicação ou serviço em execução em um host, o nome do dispositivo ou aplicação deve ser preenchido neste campo. Por exemplo, Disco C ou NIC 001 ou Aplicação web de comércio .
      metric_name Nome da métrica que acionou o alerta. Por exemplo, Memória usada ou Utilização total da CPU .
      tipo O tipo de evento. Este tipo pode ser semelhante ao metric_name , mas é usado para agrupamento geral de tipos de evento.
      message_key Este valor é usado para desduplicação de eventos. Por exemplo, pode haver dois eventos para o mesmo IC, em que um evento tem CPU de 50% e o próximo evento tem CPU de 99%. Ambos os eventos devem ser mapeados para o mesmo alerta da ServiceNow, eles devem ter a mesma chave de mensagem. O campo pode ser deixado em branco, caso em que o valor do campo é padronizado como origem, nó, tipo, recurso, métrica_name . . message_key deve ser preenchido somente quando houver um identificador melhor do que o padrão.
      severidade Gravidade do evento. Os valores da ServiceNow para severidade variam de 1 – Crítico a 5 – OK, com a gravidade de 0 – Limpa. Os valores de gravidade originais devem ser enviados como parte das informações adicionais.
      additional_info Este campo está no formato de chave/valor JSON e deve conter todas as informações que possam ser úteis para o usuário. Ele não é mapeado para um campo de evento predefinido da ServiceNow. Os exemplos incluem IDs de objetos na origem do evento, prioridade do evento (se não for igual à gravidade), informações do grupo de atribuição e assim por diante. Valores em Informações adicionais O campo de um evento que não está no formato de chave/valor JSON é normalizado para o formato JSON quando o evento é processado.
      time_of_event Hora em que o evento ocorreu na origem do evento. O formato é: aaaa-MM-dd HH:mm:ss

      A hora especificada deve estar de acordo com GMT.

      resolution_state Opcional - Para indicar que um evento foi resolvido ou não está mais ocorrendo, alguns monitores de evento usam a severidade "Limpar", enquanto outros monitores de evento usam um valor "Fechar" para a severidade. Este campo é usado para os monitores que fornecem o último. Os valores válidos são Novo e. Fechando .
    3. Para criar vários registros com uma única chamada, acione o serviço web de evento usando a seguinte URL, em que a variável <instance name> é substituída pelo nome da instância necessária:
      https://<instancename>.service-now.com/api/global/em/jsonv2
      Exemplo que mostra a carga de dois eventos que são enviados em uma única chamada de serviço web:
      {
        "records": [
          {
            "source": "SCOM",
            "event_class": "SCOM 2012 on scom.server.com",
            "resource": "D:",
            "node": "name.of.node.com",
            "metric_name": "Percentage Logical Disk Free Space",
            "type": "Disk space",
            "severity": "4",
            "description": "The disk D: on computer V-W2K8-abc.abc.com is running out of disk space. The value that exceeded the threshold is 38% free space.",
            "additional_info": {
              "scom-severity": "Medium",
              "metric-value": "38",
              "os_type": "Windows.Server.2008"
            }
          },
          {
            "source": "SCOM",
            "event_class": "SCOM 2012 on scom.server.com",
            "resource": "MSSQL-database-name",
            "node": "other.node.com",
            "metric_name": "DB Allocated Size (MB)",
            "type": "Database Storage",
            "severity": "3",
            "description": "High number of active connections for MSSQL-database-name running on name.of.node.com. Active connections exceed 5000.",
            "additional_info": {
              "scom-severity": "Medium",
              "metric-value": "38",
              "os_type": "Windows.Server.2008"
            }
          }
        ]
      }
    4. Para criar um registro com uma única chamada, acione o serviço web de evento usando a seguinte URL, em que a variável <instancename> é substituída pelo nome da instância necessária:
      https://<instancename>.service-now.com/api/global/em/jsonv2
      Exemplo que mostra a carga de um evento que é enviado em uma única chamada de serviço web:
      {
        "records": [
          {
            "source": "SCOM",
            "event_class": "SCOM 2007 on scom.server.com",
            "resource": "C:",
            "node": "name.of.node.com",
            "metric_name": "Percentage Logical Disk Free Space",
            "type": "Disk space",
            "severity": "4",
            "description": "The disk C: on computer V-W2K8-dfg.dfg.com is running out of disk space. The value that exceeded the threshold is 41% free space.",
            "additional_info": {
              "scom-severity": "Medium",
              "metric-value": "38",
              "os_type": "Windows.Server.2008"
            }
          }
        ]
      }
      Exemplo: Solicitação de curl:
      {
        curl -X POST "https://<instancename>.service-now.com/api/global/em/jsonv2" \
        --header "Content-Type: application/json" \
        --user "username:password" \
        --data '{
          "records": [
            {
              "source": "SCOM",
              "event_class": "SCOM 2007 on scom.server.com",
              "resource": "C:",
              "node": "name.of.node.com",
              "metric_name": "Percentage Logical Disk Free Space",
              "type": "Disk space",
              "severity": "4",
              "description": "The disk C: on computer V-W2K8-dfg.dfg.com is running out of disk space. The value that exceeded the threshold is 41% free space.",
              "additional_info": {
                "scom-severity": "Medium",
                "metric-value": "38",
                "os_type": "Windows.Server.2008"
              }
            }
          ]
        }'