API de Métricas de Push

A API de métricas de envio fornece endpoints que permitem enviar dados brutos Inteligência operacional de uma fonte externa para o MID Server.

Esta API é baseada em ferramentas do lado do cliente que enviam por push os dados brutos da fonte externa para o MID Server. A extensão Métricas operacionais deve ser configurada com a opção Habilitar ouvinte REST habilitada. Para obter mais informações sobre como configurar o MID Server, consulte Introdução à Inteligência operacional.

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

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

Envia dados brutos Inteligência operacional de uma fonte externa para o MID Server.

Formato da 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. Parâmetros do corpo da solicitação (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, era 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	A fonte de dados que monitora o tipo de métrica. Tipo de dados: cadeia de caracteres
timestamp	Carimbo de data/hora do período da métrica. Tipo de dados: número Unidade: Milissegundos
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/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

Tabela 6. Códigos de status

Código de 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"
}]"