Guia do desenvolvedor de monitoramento sintético

Use APIs de monitoramento sintético Crie vários monitores sintéticos em uma única operação.

Este guia do desenvolvedor fornece informações sobre como usar o. Synthetic monitoring APIs para criar monitores em massa do Postman ou Terminal.

Para obter a documentação de referência completa para APIs de monitoramento sintético, consulte:

• API SintéticosAsyncBulkCreate
• API Sintéticos em bulkCreate

Importe e crie monitores sintéticos em massa usando a API

Crie vários monitores sintéticos simultaneamente importando brutos JSON ou CSV arquivos por meio de SínteticsAssyncBulkCriar API.

Antes de Iniciar

Função necessária: sn_sow_synthetics.synthetics_admin ou sn_sow_synthetics.synthetics_editor

• Credenciais válidas da instância da ServiceNow
• Acesso ao endpoint HTTP
• URL de base: https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create
• Arquivo JSON ou CSV bruto preparado com dados de monitoramento que contêm campos obrigatórios:
  • Nome do monitor
  • Sys_id do endpoint HTTP
  • Sys_id do serviço primário
  • Sys_id do local
  • sys id do grupo de suporte
  • intervalo (frequência)
  • MÉTODO ("GET", "POST", "PUT", "DELETE", "PATCH", "CABEÇA")
  • Campo de asserção

Uma das seguintes ferramentas: Terminal (com comando curl), Postman ou ambiente de script.

Por Que e Quando Desempenhar Esta Tarefa

. SínteticsAssyncBulkCriar A API usa um processo de duas etapas:

1. Cria um ID de trabalho carregando seu arquivo de dados do monitor.
2. Verifica o status do trabalho para verificar o status de criação do monitor.

Você pode acessar esta API por meio de um dos seguintes métodos:

• Terminal usando comandos curl
• Aplicação Postman
• Scripts personalizados

A API requer uma autenticação básica ou autenticação de token OAUTH.

• Autenticação básica:

  curl -u "username:password"

• Token do OAuth:

  CURL -H "Autorização: <your-oauth-token> do portador"

Procedimento

1. Prepare seu arquivo de dados do monitor no formato JSON bruto ou CSV.
2. Escolha o método preferido (Terminal, Postman ou Script).
3. Chame o endpoint da API de importação em massa para carregar o arquivo e gerar um ID de trabalho.
4. Use o URL de verificação de status para verificar o status de criação do monitor.
5. Revise a resposta para detalhes de erro ou criação bem-sucedida do monitor.
6. Atualize o arquivo de origem com os dados corretos (se houver erros) e reenvie.

Resultado

Os monitores são criados na instância da ServiceNow. A resposta da API indica:

• Status de processamento (processamento/concluído)
• Monitores criados com sucesso
• Monitores com falha com detalhes de erro (campos obrigatórios ausentes, sys_ids inválidos e assim por diante)

Crie monitores em massa usando o Terminal

Use comandos curl no Terminal para criar vários monitores sintéticos simultaneamente importando arquivos JSON ou CSV por meio do SínteticsAssyncBulkCriar API.

Antes de Iniciar

Função necessária: sn_sow_synthetics.synthetics_admin ou sn_sow_synthetics.synthetics_editor

• Credenciais válidas da instância da ServiceNow
• Acesso ao endpoint HTTP
• URL de base: https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create
• Arquivo JSON ou CSV bruto preparado com dados de monitoramento que contêm campos obrigatórios:
  • Nome do monitor
  • Sys_id do endpoint HTTP
  • Sys_id do serviço primário
  • Sys_id do local
  • sys id do grupo de suporte
  • intervalo (frequência)
  • MÉTODO ("GET", "POST", "PUT", "DELETE", "PATCH", "CABEÇA")
  • Campo de asserção

Por Que e Quando Desempenhar Esta Tarefa

. SínteticsAssyncBulkCriar A API usa um processo de duas etapas quando acessada por meio do Terminal. Primeiro, carregue seu arquivo de dados do monitor usando um comando curl para gerar um ID de trabalho. Em seguida, verifique o status do trabalho para verificar a criação do monitor. A API processa registros de forma assíncrona e fornece feedback detalhado sobre criações e erros bem-sucedidos.

Diferentes comandos cURL são necessários, dependendo se você está carregando um arquivo JSON ou CSV.

Procedimento

1. Abra o Terminal no seu sistema.
2. Navegue até o diretório que contém o arquivo de dados do monitor.
3. Execute o comando curl apropriado para carregar seu arquivo e criar um ID de trabalho.

   Para arquivos JSON:

   curl -X POST "https://{your-instance}.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -u "admin:password" \
     -d @{filename}.json

   Para arquivos CSV:

   curl -X POST "https://{your-instance}.service-now.com/api/sn_now_synthetics/v1/synthetics_async_bulk_create?filename=filename.csv" \
     -H "Content-Type: text/csv" \
     -H "Accept: application/json" \
     -u "admin:password" \
     --d "$(jq -Rs '{csv_content: .}'filename.csv"

   Substitua os seguintes espaços reservados:

   • (sua-instância) : O nome da instância da ServiceNow
   • (nome do arquivo) : O nome do arquivo de dados do monitor

   A API retorna uma resposta que contém um ID de trabalho e um URL de verificação de status.

   {
     "result": {
       "job_id": "abc123def456",
       "status": "processing",
       "status_check_url": "https://{your-instance}.service-now.com/api/now/synthetic/monitor/bulk/status/abc123def456"
     }
   }

4. Copie o URL de verificação de status da resposta.
5. Execute o comando curl de verificação de status para verificar o status do processamento do trabalho.

   curl -X GET "https://{your-instance}.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create/{job_id}" \
     -H "Accept: application/json" \
     -u "{username}:{password}"

   A API retorna uma das seguintes respostas de status:

   Status de processamento:

   {
     "result": {
       "job_id": "abc123def456",
       "status": "processing",
       "total_records": 10,
       "processed_records": 3
     }
   }

   Status concluído (bem-sucedido):

   {
     "result": {
       "job_id": "abc123def456",
       "status": "complete",
       "total_records": 10,
       "successful_records": 10,
       "failed_records": 0,
       "details": []
     }
   }

   Status concluído (com erros):

   {
     "result": {
       "job_id": "abc123def456",
       "status": "complete",
       "total_records": 10,
       "successful_records": 8,
       "failed_records": 2,
       "details": [
         {
           "name": "Monitor_API_001",
           "status": "failed",
           "error_code": "MISSING_REQUIRED_FIELD",
           "reason": "CMDB CI is required"
         },
         {
           "name": "Monitor_API_002",
           "status": "failed",
           "error_code": "INVALID_REFERENCE",
           "reason": "Location not found for this sys_id"
         }
       ]
     }
   }

6. Se o status for "Processando", aguarde alguns momentos e repita o comando de verificação de status.
   O sistema processa registros de forma assíncrona. Continue verificando até que o status mude para "Concluído".
7. Se algum monitor falhar ao criar, revise os detalhes do erro na resposta.
   1. Identifique o nome do monitor com falha no compilado detalhes.
   2. Revise o código de erro e o motivo fornecidos.
   3. Atualize seu arquivo JSON ou CSV de origem para corrigir os problemas de dados.

      Os erros comuns incluem:

      • Campos obrigatórios ausentes (IC do CMDB, local, método)
      • Referências sys_id inválidas que não existem na instância
      • Formatos de dados incorretos
   4. Reenvie o arquivo corrigido repetindo o comando Upload curl.

Resultado

Os monitores são criados em sua instância da ServiceNow. Os monitores criados com sucesso estão imediatamente disponíveis para uso. Monitores com falha são relatados com detalhes de erro específicos, permitindo que você corrija os dados e reenvie.

Exemplo de fluxo de trabalho completo

Passo 1: Carregue o arquivo JSON

curl -X POST "https://myinstance.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -u "admin:password123" \
  -d @monitor_data.json

Resposta:

{
  "result": {
    "job_id": "xyz789abc123",
    "status": "processing",
    "status_check_url": "https://myinstance.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create/status/xyz789abc123"
  }
}

Etapa 2: Verificar o status

curl -X GET "https://myinstance.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create/status/xyz789abc123" \
  -H "Accept: application/json" \
  -u "admin:password123"

Resposta final:

{
  "result": {
    "job_id": "xyz789abc123",
    "status": "complete",
    "total_records": 5,
    "successful_records": 5,
    "failed_records": 0
  }
}

O que Fazer Depois

Após a criação bem-sucedida, verifique seus monitores na IU da ServiceNow navegando até Monitoramento Sintético > Monitores. Você pode definir configurações e cronogramas adicionais do monitor , conforme necessário.

Crie monitores em massa usando o Postman

Use o Postman para criar vários monitores sintéticos simultaneamente importando arquivos JSON ou CSV por meio do SínteticsAssyncBulkCriar API.

Antes de Iniciar

Função necessária: sn_sow_synthetics.synthetics_admin ou sn_sow_synthetics.synthetics_editor

• Credenciais válidas da instância da ServiceNow
• Acesso ao endpoint HTTP
• URL de base: https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create
• Arquivo JSON ou CSV bruto preparado com dados de monitoramento que contêm campos obrigatórios:
  • Nome do monitor
  • Sys_id do endpoint HTTP
  • Sys_id do serviço primário
  • Sys_id do local
  • sys id do grupo de suporte
  • intervalo (frequência)
  • MÉTODO ("GET", "POST", "PUT", "DELETE", "PATCH", "CABEÇA")
  • Campo de asserção

Por Que e Quando Desempenhar Esta Tarefa

. SínteticsAssyncBulkCriar A API usa um processo de duas etapas quando acessada pelo Postman. Primeiro, crie uma solicitação POST para carregar seu arquivo de dados do monitor e gerar um ID de trabalho. Em seguida, use o URL de verificação de status para verificar a criação do monitor. O Postman fornece uma interface amigável para testar a API e exibir respostas formatadas.

A mesma configuração do Postman funciona para arquivos JSON e CSV, com apenas a seleção de formato de arquivo diferente.

Procedimento

1. Abra a aplicação Postman.
2. Selecione uma nova solicitação . ou Novo(a) > Solicitação HTTP.
3. Defina o método de solicitação como PUBLICAÇÃO No menu suspenso, insira a URL base do endpoint da API de importação em massa no campo URL da solicitação.

   Substituir (instance-name) No URL base com seu ServiceNow nome da instância.

4. Configure credenciais de autenticação.
   1. Selecione Autorização abaixo de URL campo.
   2. Selecione Autenticação básica em Tipo menu suspenso.
   3. Insira seu ServiceNow nome de usuário no Nome de usuário campo.
      Certifique-se de que este usuário tenha a função de administrador sintético.
   4. Insira sua senha em Senha campo.
5. Configure o corpo da solicitação para carregar seu arquivo de dados do monitor.
   1. Selecione a guia Corpo.
   2. Selecione binário como o tipo de corpo.
   3. Selecione Selecione Arquivo E navegue até o local do arquivo de dados do monitor e selecione o arquivo JSON ou CSV.
      Se você estiver carregando um arquivo CSV, certifique-se de que ele esteja formatado corretamente com todas as colunas necessárias. Converta o arquivo CSV para o formato JSON
6. Adicione o nome do arquivo como um parâmetro de consulta na URL e selecione Enviar para enviar a solicitação.
   Por exemplo, se o seu nome de arquivo for Monitores .json, então o caminho do arquivo será https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create?filename=monitors.json
   A API retorna uma resposta JSON que contém um ID de trabalho e um URL de verificação de status.

   em "job_id": "abc123def456", "status": "processing", "status_check_url": "https://{instance-name}.service-now.com/api/now/synthetic/monitor/bulk/status/abc123def456"]

7. Copie o URL de verificação de status da resposta.
8. Crie uma nova solicitação GET para verificar o status do trabalho.
   1. Clique no URL de verificação de status na resposta ou crie manualmente uma nova solicitação.
      Se o URL puder ser clicado no Postman, ele criará automaticamente uma nova solicitação GET com o URL preenchido.
   2. Se estiver criando manualmente, defina o método de solicitação como OBTER .
   3. Cole o URL de verificação de status ( https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create/{job_id} em ß campo.

      Substitua [job_id] pelo ID do trabalho da resposta POST.

9. Configure a autenticação para a solicitação de verificação de status.
   Se você estiver no mesmo espaço do Postman, a autorização já pode ter sido herdada. Caso contrário, repita a configuração de Autenticação básica da etapa 4.
10. Selecione Enviar para verificar o status do trabalho.
    Você pode salvar as solicitações em uma coleção para reutilização.

    A API retorna uma das seguintes respostas de status:

    Status de processamento:

    {
      "result": {
        "job_id": "abc123def456",
        "status": "processing",
        "total_records": 10,
        "processed_records": 3
      }
    }

    Status concluído (bem-sucedido):

    {
      "result": {
        "job_id": "abc123def456",
        "status": "complete",
        "total_records": 10,
        "successful_records": 10,
        "failed_records": 0,
        "details": []
      }
    }

    Status concluído (com erros):

    {
      "result": {
        "job_id": "abc123def456",
        "status": "complete",
        "total_records": 10,
        "successful_records": 8,
        "failed_records": 2,
        "details": [
          {
            "name": "Monitor_API_001",
            "status": "failed",
            "error_code": "MISSING_REQUIRED_FIELD",
            "reason": "CMDB CI is required"
          },
          {
            "name": "Monitor_API_002",
            "status": "failed",
            "error_code": "INVALID_REFERENCE",
            "reason": "Location not found for this sys_id"
          }
        ]
      }
    }

11. Se o status for "Processando", aguarde alguns momentos e selecione Enviar novamente para atualizar o status.
    O sistema processa registros de forma assíncrona. Continue verificando até que o status mude para "Concluído".
12. Se algum monitor falhar ao criar, revise os detalhes do erro na resposta.
    1. Expanda o. detalhes Matriz no visualizador de resposta do Postman para ver registros de erro individuais.
    2. Anote o nome do monitor, o código de erro e o motivo de cada falha.
    3. Atualize seu arquivo JSON ou CSV de origem para corrigir os problemas identificados.

       Os erros comuns incluem:

       • Campos obrigatórios ausentes (IC do CMDB, local, método)
       • Referências sys_id inválidas que não existem na instância
       • Nomes de campos ou formatos de dados incorretos
    4. Retorne à sua solicitação POST original e reenvie com o arquivo corrigido.

Resultado

Os monitores são criados em sua instância da ServiceNow. Os monitores criados com sucesso estão imediatamente disponíveis para uso. Monitores com falha são relatados com detalhes de erro específicos em um formato JSON estruturado que é fácil de revisar no visualizador de respostas do Postman.

Exemplo de fluxo de trabalho completo

Etapa 1: Configurar solicitação POST

• Método: POST
• URL: https://myinstance.service-now.com/api/now/synthetic/monitor/bulk/import
• Autorização: Autenticação básica (nome de usuário: administrador, senha: !!**)
• Arquivo selecionado: Monitor_data.json
• Cabeçalhos: Content-Type: Application/json, Accept: Application/json

Resposta recebida:

{
  "result": {
    "job_id": "xyz789abc123",
    "status": "processing",
    "status_check_url": "https://myinstance.service-now.com/api/now/synthetic/monitor/bulk/status/xyz789abc123"
  }
}

Etapa 2: Configure a solicitação de OBTENÇÃO para verificação de status

• Método: GET
• URL: https://myinstance.service-now.com/api/now/synthetic/monitor/bulk/status/xyz789abc123
• Autorização: Autenticação básica (herdada do espaço)

Resposta final:

{
  "result": {
    "job_id": "xyz789abc123",
    "status": "complete",
    "total_records": 5,
    "successful_records": 5,
    "failed_records": 0
  }
}

O que Fazer Depois

• Salve suas solicitações do Postman em uma coleção para uso futuro e reenvio fácil.
• Verifique seus monitores na IU da ServiceNow navegando até Monitoramento sintético > Monitores.
• Defina configurações adicionais do monitor, como cronogramas, notificações e limites, conforme necessário.

Converta o arquivo CSV para o formato JSON

Converta seu arquivo CSV para o formato JSON para criar monitores sintéticos.

Arquivo CSV para o formato JSON

Para converter o arquivo CSV para o formato JSON, acesse o terminal. Dependendo do seu sistema operacional, execute os comandos necessários.

Tabela 1. Comandos para converter arquivo CSV para o formato JSON

Sistema operacional	Comandos curl
macOS	"" csv_content: ." filename.csv
Windows PowerShell	Se estiver usando jq, use o comando "" csv_content: ." filename.csv Se estiver usando somente PowerShell (nenhum jq instalado), use os comandos: Get-content -Path "Synthetic_checks.csv" -Raw Para criar um arquivo de json, clique em ConvertTo-json json Se estiver usando o prompt de comando do Windows com jq instalado, use o comando " filename.csv

A saída é um conteúdo CSV encapsulado no formato JSON que está disponível no terminal. "Csv_content": "Name,method,description,interval,cmdb_ci,..."Monitors1", "GET", "CHECK1",5,...

Quando o conteúdo estiver disponível no formato JSON, acesse o. Corpo Em Postman e selecione Bruto Para colar o conteúdo do formato JSON e selecionar Enviar .

Nota:

Certifique-se de que o formato selecionado seja JSON.

O status da resposta fornece o ID do trabalho e o status dos monitores criados. Se houver erros encontrados, corrija o arquivo e execute os mesmos comandos para concluir a criação do monitor.