Руководство. Отладка API с помощью трассировки запросов

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: Потребление | Разработчик | Базовый | Стандартный | Премиум

В этом учебнике описано, как проверить (выполнить трассировку) обработку запросов в службе Управления API. Трассировка помогает отлаживать и устранять неполадки с API.

В этом руководстве описано следующее:

  • Трассировка примера вызова.
  • Просмотр этапа обработки запроса.

Снимок экрана: инспектор API.

Примечание.

В настоящее время трассировка запросов API не поддерживается на уровнях "Базовый" версии 2 и "Стандартный" версии 2.

Необходимые компоненты

Проверка параметра "Разрешить трассировку"

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

  1. Чтобы проверить параметры, перейдите к экземпляру службы Управления API и выберите Подписки.

    Снимок экрана: разрешение трассировки для подписки.

  2. Если трассировка не включена для используемой подписки, выберите подписку и включите параметр Разрешить трассировку.

Предупреждение

  • Разрешать трассировку следует только для подписок, предназначенных для отладки. Совместное использование ключей подписки с трассировкой, разрешенной с неавторизованными пользователями, может привести к раскрытию конфиденциальных сведений, содержащихся в журналах трассировки, например ключей, маркеров доступа, паролей, внутренних имен узлов и IP-адресов.
  • В тестовой консоли Управление API автоматически отключает трассировку через 1 час после включения подписки.

Трассировка вызова

  1. Войдите на портал Azure и перейдите к своему экземпляру службы Управления API.

  2. Выберите Интерфейсы API.

  3. В списке API выберите Demo Conference API.

  4. Откройте вкладку Тест.

  5. Щелкните операцию GetSpeakers.

  6. При необходимости проверьте значение заголовка Ocp-Apim-Subscription-Key, используемого в запросе, щелкнув значок глаза.

    Совет

    Вы можете переопределить значение Ocp-Apim-Subscription-Key, получив ключ для другой подписки на портале. Выберите Подписки и откройте контекстное меню (...) другой подписки. Выберите Показать или скрыть ключи и скопируйте один из ключей. При необходимости вы также можете повторно создать ключи. Затем в тестовой консоли выберите + Добавить заголовок, чтобы добавить заголовок Ocp-Apim-Subscription-Key с новым значением ключа.

  7. Выберите Трассировка.

    • Если в подписке еще не разрешена трассировка, вам будет предложено включить ее, если вы хотите отследить вызов.

    • Вы также можете отправить запрос без трассировки.

      Снимок экрана: настройка трассировки API.

Просмотр сведений о трассировке

  1. После завершения вызова перейдите на вкладку Трассировка в разделе HTTP-ответ.

  2. Щелкните любую из следующих ссылок, чтобы перейти к подробным сведениям о трассировке: Входящие, Внутренние, Исходящие, При ошибке.

    Просмотр трассировки ответа

    • В разделе Входящие отображаются исходный запрос, полученный службой Управления API от вызывающего объекта, и примененные к запросу политики. Например, они отобразятся здесь, если вы добавили политики при работе со статьей Учебник. Преобразование и защита API.

    • В разделе Внутренние отображаются запросы, отправленные службой Управления API в серверную часть API, и полученный ответ.

    • В разделе Исходящие отображаются все политики, примененные к ответу перед отправкой обратно вызывающему объекту.

    • При ошибке — показывает ошибки, возникшие во время обработки запроса, и политики, примененные к ошибкам.

    Совет

    Для каждого шага также показано время, прошедшее с момента получения запроса службой управления API.

  3. На вкладке Сообщение заголовка ocp-apim-trace-location показано расположение данных трассировки, хранимых в хранилище BLOB-объектов Azure. При необходимости перейдите к этому расположению, чтобы получить данные трассировки. Данные трассировки доступны в течение 24 часов.

    Расположение данных трассировки в службе хранилища Azure

Включение трассировки с помощью заголовка Ocp-Apim-Trace

При выполнении запросов на Управление API с помощью curlклиента REST, например Postman или клиентского приложения, включите трассировку, добавив следующие заголовки запросов:

  • Ocp-Apim-Trace — задайте для параметра значение . true
  • Ocp-Apim-Subscription-Key — задайте значение ключа для подписки с поддержкой трассировки, которая позволяет получить доступ к API

Ответ включает заголовок Ocp-Apim-Trace-Location с URL-адресом расположения данных трассировки в хранилище BLOB-объектов Azure.

Сведения о настройке сведений о трассировки см. в политике трассировки .

Следующие шаги

Из этого руководства вы узнали, как:

  • Трассировка примера вызова.
  • Просмотр этапа обработки запроса.

Перейдите к следующему руководству:

Использование редакций