Ajuda e guiasMonitores avançados › Multi-step / API monitoring

Multi-step / API monitoring

5 min de leitura · Monitores avançados

A monitorização multietapa executa como um único monitor uma sequência de pedidos HTTP: inicia sessão, guarda um token, utiliza-o no passo seguinte e verifica a resposta através de JSONPath. É ideal para monitorizar APIs e fluxos de início de sessão em que um único pedido não chega. Disponível nos planos Pro e Business para monitores HTTP.

Onde o configuro?

  1. Abra a página de detalhe de um monitor HTTP.
  2. Na secção Multi-step / API monitoring, cole a lista JSON de passos e clique em Guardar.
  3. Um campo vazio repõe o monitor numa verificação simples clássica.

Formato do passo

Os passos são uma lista JSON (máx. 10). Cada passo é um objeto com estes campos:

  • url - o endereço do passo (obrigatório). Pode conter uma variável, p. ex. .
  • method - GET, POST, PUT, PATCH, DELETE, HEAD (GET predefinido).
  • headers - um objeto de cabeçalhos (opcional).
  • body - o corpo do pedido como texto (opcional).
  • expect_status - estado HTTP esperado (200 predefinido).
  • expect_contains - texto que tem de estar presente na resposta.
  • expect_jsonpath + expect_value - um caminho na resposta JSON e o valor esperado.
  • save - um objeto variável → JSONPath; o valor é guardado para os passos seguintes.
  • name - uma etiqueta do passo apresentada na mensagem de erro (opcional).

Exemplo: início de sessão + verificação

[
  {
    "name": "login",
    "method": "POST",
    "url": "https://api.example.com/auth/login",
    "headers": { "Content-Type": "application/json" },
    "body": "{\"user\": \"demo\", \"pass\": \"...\"}",
    "expect_status": 200,
    "save": { "token": "data.access_token" }
  },
  {
    "name": "profile",
    "url": "https://api.example.com/me",
    "headers": { "Authorization": "Bearer " },
    "expect_jsonpath": "user.active",
    "expect_value": "True"
  }
]

JSONPath

Suporta notação por pontos e índices de array: data.items[0].id, user.name, prefixo opcional $..

Como o estado é decidido: o monitor está Up apenas se todos os passos forem bem-sucedidos. Na primeira falha passa a Down e o erro indica o número e a etiqueta do passo que falhou. Tempo de resposta = a soma de todos os passos.

Bom saber

  • Um monitor multietapa é executado apenas a partir da região principal (o consenso multirregião é ignorado).
  • Os endereços de destino não podem apontar para a rede interna (a mesma proteção dos monitores normais).
  • As variáveis de save só são válidas dentro de uma única verificação.
Este guia foi útil?