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

Статья
11/05/2024

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

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

Совет

Команды API могут использовать эту функцию в рабочих областях. Рабочие области предоставляют изолированный административный доступ к API и собственным средам среды выполнения API.

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

Трассировка примера вызова в тестовой консоли
Просмотр этапа обработки запроса.
Включение трассировки для API

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

Ознакомьтесь с терминологией службы управления API в Azure.
Выполните задачи в кратком руководстве по созданию экземпляра службы управления API Azure.
Выполните следующее руководство. Импорт и публикация первого API.

Внимание

Управление API больше не поддерживает подписки для трассировки или Заголовок Ocp-Apim-Trace.
Для повышения безопасности API теперь можно включить трассировку на уровне отдельного API путем получения ограниченного по времени маркера с помощью REST API Управление API и передачи маркера в запросе шлюзу. Дополнительные сведения см. в разделе "Включение трассировки API".
Следите за включением трассировки, так как она может предоставлять конфиденциальную информацию в данных трассировки. Убедитесь, что у вас есть соответствующие меры безопасности для защиты данных трассировки.

Трассировка вызова на портале

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

Войдите на портал Azure и перейдите к своему экземпляру службы Управления API.
Выберите API-интерфейсы>.
Выберите API Petstore из списка API.
Откройте вкладку Тест.
Выберите операцию "Найти животного по идентификатору".
В параметре petId Query введите 1.
При необходимости проверьте значение заголовка Ocp-Apim-Subscription-Key, используемого в запросе, щелкнув значок глаза.

Совет

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

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

После завершения вызова перейдите на вкладку Трассировка в разделе HTTP-ответ.
Щелкните любую из следующих ссылок, чтобы перейти к подробным сведениям о трассировке: Входящие, Внутренние, Исходящие, При ошибке.
- В разделе Входящие отображаются исходный запрос, полученный службой Управления API от вызывающего объекта, и примененные к запросу политики. Например, если вы добавили политики в учебнике: преобразование и защита API, они отображаются здесь.
- В разделе Внутренние отображаются запросы, отправленные службой Управления API в серверную часть API, и полученный ответ.
- В разделе Исходящие отображаются все политики, примененные к ответу перед отправкой обратно вызывающему объекту.
- При ошибке — показывает ошибки, возникшие во время обработки запроса, и политики, примененные к ошибкам.
Совет

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

Включение трассировки для API

Для включения трассировки запроса на Управление API при использовании curl, клиента REST, например Visual Studio Code с расширением клиента REST или клиентского приложения, необходимо включить трассировку запроса на Управление API. В настоящее время эти действия необходимо выполнить с помощью REST API Управление API:

Получите маркер отладки для трассировки.
Добавьте значение маркера в заголовок запроса в Apim-Debug-Authorization шлюз Управление API.
Получите идентификатор трассировки в заголовке Apim-Trace-Id ответа.
Получите трассировку, соответствующую идентификатору трассировки.

Подробные действия.

Примечание.

Для этих действий требуется Управление API REST API версии 2023-05-01-preview или более поздней версии. Для вызова REST API необходимо назначить участника или более высокую роль в экземпляре Управление API.
Сведения о проверке подлинности в REST API см . в справочнике по REST API Azure.

Получение маркера отладки. Вызов API отладочных учетных данных шлюза Управление API. В URI введите "управляемый" для управляемого шлюза экземпляра в облаке или идентификатор шлюза для локального шлюза. Например, чтобы получить учетные данные трассировки для управляемого шлюза экземпляра, используйте запрос, аналогичный следующему:
```
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listDebugCredentials?api-version=2023-05-01-preview
```
В тексте запроса передайте полный идентификатор ресурса API, который требуется трассировать, и укажите purposes как tracing. По умолчанию учетные данные маркера, возвращаемые в ответе, истекают через 1 час, но можно указать другое значение в полезных данных. Рассмотрим пример.
```
{
    "credentialsExpireAfter": PT1H,
    "apiId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}",
    "purposes": ["tracing"]
}
```
Примечание.

Его apiId можно извлечь только из полного идентификатора ресурса, а не имени, отображаемого на портале.

Get apiId:
```
az apim api list --resource-group <resource-group> --service-name <service-name> -o table
```
Учетные данные отладки возвращаются в ответе, как показано ниже.
```
{
      "token": "aid=api-name&......."
}
```
Добавьте значение маркера в заголовок запроса. Чтобы включить трассировку запроса к шлюзу Управление API, отправьте значение маркера в заголовкеApim-Debug-Authorization. Например, для трассировки вызова API Petstore, импортированного в предыдущем руководстве, можно использовать запрос, аналогичный следующему:
```
curl -v https://apim-hello-world.azure-api.net/pet/1 HTTP/1.1 \
    -H "Ocp-Apim-Subscription-Key: <subscription-key>" \
    -H "Apim-Debug-Authorization: aid=api-name&......."
```
Оцените ответ. Ответ может содержать один из следующих заголовков в зависимости от состояния маркера отладки:
- Если маркер отладки действителен, ответ включает Apim-Trace-Id заголовок, значение которого является идентификатором трассировки, как показано ниже:
```
Apim-Trace-Id: 0123456789abcdef....
```
- Если срок действия маркера отладки истек, ответ содержит Apim-Debug-Authorization-Expired заголовок со сведениями о дате окончания срока действия.
- Если маркер отладки был получен для другого API, ответ содержит Apim-Debug-Authorization-WrongAPI заголовок с сообщением об ошибке.
Получите трассировку. Передайте идентификатор трассировки, полученный на предыдущем шаге, в API трассировки списка шлюза. Например, чтобы получить трассировку для управляемого шлюза, используйте запрос, аналогичный следующему:
```
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/managed/listTrace?api-version=2023-05-01-preview
```
В тексте запроса передайте идентификатор трассировки, полученный на предыдущем шаге.
```
{
    "traceId": "0123456789abcdef...."
}
```
Текст ответа содержит данные трассировки для предыдущего запроса API к шлюзу. Трассировка похожа на трассировку, которую можно увидеть, трассировка вызова в тестовой консоли портала.

Пример `.http` файла для расширения REST Client VS Code

Чтобы автоматизировать эти действия с расширением REST Client Visual Studio Code, можно использовать следующий пример .http файла:

@subscriptionId = // Your subscription ID
@resourceGroup = // Your resource group
@apimName = // Your API Management service name
@clientId = // Client ID from an app registration for authentication
@clientSecret = // Client secret from app registration
@externalHost = // The host name of the App Gateway or the fully qualified gateway URL
@subscriptionKey = // API Management subscription key
@apiEndPoint = // API URL
@requestBody = // Data to send
@tenantId = // Tenant ID
 
POST https://login.microsoftonline.com/{{tenandId}}/oauth2/token
content-type: application/x-www-form-urlencoded
 
grant_type=client_credentials&client_id={{clientId}}&client_secret={{clientSecret}}&resource=https%3A%2F%2Fmanagement.azure.com%2F
 
###
@authToken = {{login.response.body.$.access_token}}
###
# @name listDebugCredentials
POST https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroup}}/providers/Microsoft.ApiManagement/service/{{apimName}}/gateways/managed/listDebugCredentials?api-version=2023-05-01-preview
Authorization: Bearer {{authToken}}
Content-Type: application/json
{
    "credentialsExpireAfter": "PT1H",
    "apiId": "/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroup}}/providers/Microsoft.ApiManagement/service/{{apimName}}/apis/{{apiId}}",
    "purposes": ["tracing"]
}
 
###
@debugToken = {{listDebugCredentials.response.body.$.token}}
 
###
# @name callApi
curl -k -H "Apim-Debug-Authorization: {{debugToken}}" -H 'Host: {{externalHost}}' -H 'Ocp-Apim-Subscription-Key: {{subscriptionKey}}' -H 'Content-Type: application/json' '{{apiEndPoint}}' -d '{{requestBody}}'
 
###
@traceId = {{callApi.response.headers.Apim-Trace-Id}}
 
###
# @name getTrace
POST https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroup}}/providers/Microsoft.ApiManagement/service/{{apimName}}/gateways/managed/listTrace?api-version=2024-06-01-preview
Authorization: Bearer {{authToken}}
Content-Type: application/json
 
{
    "traceId": "{{traceId}}"
}

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

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

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

Трассировка примера вызова в тестовой консоли
Просмотр этапа обработки запроса.
Включение трассировки для API

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

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

Поделиться через

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

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

Трассировка вызова на портале

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

Включение трассировки для API

Пример `.http` файла для расширения REST Client VS Code

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

Обратная связь

Дополнительные ресурсы

Поделиться через

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

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

Трассировка вызова на портале

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

Включение трассировки для API

Пример .http файла для расширения REST Client VS Code

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

Обратная связь

Дополнительные ресурсы

Пример `.http` файла для расширения REST Client VS Code