Как использовать API Monitoring Management API

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

С помощью API Monitoring management API можно выполнять следующие задачи:

Задача Дополнительная информация
Как управлять оповещениями для мониторинга API
Как управлять коллекциями для мониторинга API
Как просматривать журналы мониторинга API на разных уровнях
Как посмотреть показатели API Monitoring

Квоты на вызовы API

Для всех API мониторинга API действует квота, ограничивающая количество вызовов API в минуту. Например, API Create collections позволяет выполнять не более шести вызовов в минуту.

У разных API разные лимиты квот. Чтобы узнать лимит для каждого API, ознакомьтесь с справочной документацией по API.

Как использовать curl

В примерах API, приведенных в этом документе, используется curl, чтобы показать, как использовать API Monitoring с помощью API. curl – это инструмент командной строки с открытым исходным кодом для передачи данных с использованием синтаксиса URL, поддерживающий распространенные протоколы, такие как HTTP и HTTPS. Информацию о том, как скачать и использовать curl, можно найти на сайте https://curl.haxx.se/.

В таблице ниже приведены параметры командной строки curl, которые используются в примерах.

Вариант Описание
-d '{}'

--data @filename

Определяет тело запроса, передаваемое напрямую или путем указания имени файла.
-H

--header

Определяет заголовок запроса. В заголовке запроса необходимо передать следующую информацию:
  • Токен OAuth 2.0 для аутентификации пользователя с помощью заголовка Authorization, как описано в разделе Как получить токен доступа OAuth 2.0.
  • Типы контента, поддерживаемые клиентом, с использованием заголовка Accept.
  • Тип контента тела запроса, отправляемого при создании или обновлении ресурса (POST, PATCH, PUT) с помощью заголовка Content-Type.
-i Показывает в ответе больше информации, например заголовки.
-X Указывает тип запроса (GET, POST и т. д.).

Как получить токен доступа OAuth 2.0

Apigee Edge поддерживает OAuth 2.0 для аутентификации пользователей. С помощью OAuth 2.0 вы можете обменять учетные данные Apigee Edge на токен доступа и токен обновления, которые затем можно использовать для безопасных вызовов Apigee Edge API. После получения токена вам не нужно будет снова обменивать учетные данные, пока не истечет срок действия токена. Токен обновления позволяет поддерживать сеанс с сервером в течение более длительного периода без предоставления учетных данных. Подробнее об использовании OAuth2 для доступа к API управления…

Используя учетные данные Apigee Edge, вы можете получить токены доступа и обновления OAuth 2.0 для доступа к ресурсам Apigee Edge с помощью утилиты get_token от Apigee.

Чтобы получить токен доступа OAuth 2.0:

  1. Установите утилиту get_token. Инструкции по установке утилиты get_token приведены в статье Как использовать get_token.

  2. Выполните команду get_token, чтобы получить токен доступа OAuth 2.0.

    При первом вводе команды или если срок действия токена обновления истек, get_token запросит имя пользователя, пароль и шестизначный код двухфакторной аутентификации. Введите каждое значение, когда будет предложено. Если двухфакторная аутентификация не включена, просто нажмите клавишу Ввод.

  3. Скопируйте токен OAuth 2.0 и сохраните его в переменной, например ACCESS_TOKEN: 

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

При вызове Monitoring API передайте токен доступа OAuth 2.0 в заголовке HTTP, используя заголовок Authorization. Пример:


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