Диагностика ошибок в API

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

Техническая поддержка сможет быстрее решить вашу проблему, если вы будете использовать дополнительные заголовки HTTP-запросов и ответов.

Заголовки запросов

При отправке HTTP-запросов используйте следующие заголовки:

  • x-client-request-id — уникальный идентификатор запроса. Рекомендуем использовать UUID. Сообщите этот идентификатор технической поддержке, чтобы мы смогли найти конкретный запрос в системе и помочь вам.

    Вы можете сгенерировать UUID онлайн или воспользоваться библиотекой для используемого языка программирования.

  • x-data-logging-enabled — флаг, разрешающий сохранять данные, переданные пользователем в запросе.

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

Примеры

Например, эти заголовки помогут найти ваш поисковый запрос в синхронном режиме.

curl \
          --request POST \
          --header "Authorization: Bearer <IAM-токен>" \
          --data "@body.json" \
          "https://searchapi.api.cloud.yandex.net/v2/web/search" \
          > result.json

Заголовки ответов

Каждый ответ сервера содержит заголовки, которые позволят получить еще больше информации о ходе выполнения запроса:

  • x-request-id — уникальный идентификатор ответа.
  • x-server-trace-id — уникальный идентификатор логов выполнения запроса.

Чтобы получить значения x-request-id и x-server-trace-id, ваше приложение должно логировать заголовки ответов сервера.

Пример реализации доступа к заголовкам протокола gRPC приведен в документации библиотеки grpc-go.

Предыдущая
Коды ошибок
Следующая
Операторы поиска