Используйте API управления мониторингом API

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

Используйте API управления мониторингом для выполнения следующих задач.

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

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

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

Не все API имеют одинаковые ограничения по объему трафика. Для определения лимита обратитесь к справочной документации по каждому API.

Используйте curl

В примерах использования API в этом документе используется curl для демонстрации работы мониторинга 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 на токен доступа и токен обновления, которые затем можно использовать для безопасных вызовов к API Apigee Edge. После получения токена вам не нужно снова обменивать свои учетные данные до истечения срока действия токена. Токен обновления позволяет поддерживать вашу «сессию» с сервером в течение более длительного периода без предоставления учетных данных. Для получения дополнительной информации о токенах доступа см. раздел «Использование 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 запросит у вас имя пользователя, пароль и шестизначный код двухфакторной аутентификации. Введите каждое значение по запросу. Если у вас не включена двухфакторная аутентификация, просто нажмите Enter в командной строке.

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

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

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


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