API de métricas por push

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 2 min. de leitura
  • . Métricas por push A API fornece endpoints que permitem enviar por push brutos Inteligência para métricas dados de uma fonte externa para MID Server.

    Esta API é baseada em ferramentas do lado do cliente que enviam os dados brutos da fonte externa para o. MID Server. . Inteligência para métricas a extensão deve ser configurada com Habilitar Ouvinte REST opção habilitada. Para obter mais informações sobre como configurar o. MID Server, consulte Comece a usar o Inteligência de métricas .

    Para obter informações sobre requisitos de autenticação, consulte Configure a extensão do MID Web Server .

    Métricas por push - POST /mid/sa/metrics

    Envia o bruto Inteligência para métricas dados de uma fonte externa para MID Server.

    Formato de URL

    URL padrão: /api/mid/sa/metrics

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    ci2metric_id Lista de pares de chave-valor a serem usados para identificar o item de configuração (IC). Anteriormente, é conhecido como ci_identifier. O script continua a aceitar ci_identifier.

    Tipo de dados: Objeto

    metric_type Nome da métrica.

    Tipo de dados: Cadeia de caracteres

    node Endereço IP, FQDN, nome do IC ou host. No exemplo abaixo, o nome do servidor Linux em que os discos estão instalados.

    Tipo de dados: Cadeia de caracteres

    resource_path O caminho do recurso para o qual os dados de métrica estão sendo coletados. No exemplo abaixo, C é o recurso para o qual os dados de métrica são coletados.

    Tipo de dados: Cadeia de caracteres

    origem Fonte de dados monitorando o tipo de métrica.

    Tipo de dados: Cadeia de caracteres

    carimbo de data/hora Carimbo de data/hora da época da métrica.

    Tipo de dados: Número

    Unidade: Milissegundos

    unidade Tipo de unidade associado ao tipo de métrica de origem.

    Tabela: Tipos de métrica do sistema de monitoramento [sa_source_metric_type]

    Tipo de dados: Cadeia de caracteres

    valor Valor da métrica.

    Tipo de dados: Número

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json

    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    Nenhum(a)

    Solicitação de curl

    O corpo da solicitação deve estar entre colchetes, conforme mostrado neste exemplo.

    curl -X POST "https://servicenow-instance/api/mid/sa/metrics"
    -H "Content-Type: application/json"
    -U "username":"password"
    -d "[{
        "metric_type": "Disk C: % Free Space",
        "resource_path": "C:\\",
        "node": "lnux100",
        "value": 50,
        "timestamp": 1473183012000,
        "ci2metric_id": {
            "node": "lnux100"
        },
        "source": "Splunk"
    }]"