Usar a API Monitoring Management

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Use a API de gerenciamento de monitoramento de APIs para realizar as seguintes tarefas.

Tarefa Mais informações
Gerenciar alertas para a API Monitoring
Gerenciar coleções para a API Monitoring
Ver os registros da API Monitoring em diferentes níveis
Visualizar métricas da API Monitoring

Cotas de chamada de API

Todas as APIs da API Monitoring aplicam uma cota que limita o número de vezes por minuto que você pode chamar a API. Por exemplo, a API Create Collections está limitada a seis chamadas por minuto.

Nem todas as APIs têm os mesmos limites de cota. Consulte a documentação de referência da API de cada uma para determinar o limite.

Usar curl

Os exemplos de API deste documento usam curl para demonstrar como usar a API Monitoring com a API. O curl é uma ferramenta de linha de comando de código aberto para transferência de dados com sintaxe de URL, compatível com protocolos comuns como HTTP e HTTPS. Para saber como fazer o download e usar o curl, consulte https://curl.haxx.se/.

A tabela a seguir resume as opções de linha de comando curl usadas nos exemplos.

Opção Descrição
-d '{}'

--data @filename

Define o corpo da solicitação, transmitido diretamente ou especificando um nome de arquivo.
-H

--header

Define um cabeçalho de solicitação. É necessário transmitir as seguintes informações no cabeçalho da solicitação:
  • Token OAuth 2.0 para autenticação do usuário usando o cabeçalho Authorization, conforme descrito em Como receber um token de acesso do OAuth 2.0.
  • Tipos de conteúdo compatíveis com o cliente usando o cabeçalho Accept.
  • Tipo de conteúdo do corpo da solicitação enviado ao criar ou atualizar um recurso (POST, PATCH, PUT) usando o cabeçalho Content-Type.
-i Exibe mais informações na resposta, como cabeçalhos.
-X Especifica o tipo de solicitação (GET, POST e assim por diante).

Receber um token de acesso do OAuth 2.0

O Apigee Edge é compatível com o OAuth 2.0 para autenticação de usuários. Com o OAuth 2.0, você troca credenciais das Apigee Edge por um token de acesso e um token de atualização que pode ser usado para fazer chamadas seguras à API Apigee Edge. Depois de receber um token, você não precisa trocar suas credenciais novamente até o token expirar. O token de atualização permite manter ativa a "sessão" com o servidor por um período mais longo sem fornecer suas credenciais. Para mais informações sobre tokens de acesso, consulte Como usar o OAuth2 para acessar a API de gerenciamento.

Usando suas credenciais da Apigee Edge, é possível conseguir tokens de acesso e de atualização do OAuth 2.0 para acessar recursos da Apigee Edge usando o utilitário get_token da Apigee.

Para conseguir um token de acesso do OAuth 2.0:

  1. Instale o utilitário get_token: Para informações sobre como instalar o utilitário get_token, consulte Como usar get_token.

  2. Execute get_token para receber um token de acesso do OAuth 2.0.

    Na primeira vez que você digitar o comando ou se o token de atualização tiver expirado, o get_token solicitará seu nome de usuário, sua senha e o código de autenticação de dois fatores. Digite cada valor quando solicitado. Se a autenticação de dois fatores não estiver ativada, basta pressionar Enter no prompt.

  3. Copie o token OAuth 2.0 e armazene-o em uma variável, como ACCESS_TOKEN:

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

Ao chamar a API Monitoring, transmita o token de acesso OAuth 2.0 no cabeçalho HTTP usando o cabeçalho Authorization. Por exemplo:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...