Данные о лимите запросов

Запрос позволяет получить информацию о запросах к API сервисов Яндекса. Тело ответа содержит данные об отправленных запросах и допустимое количество запросов, которые пользователь может отправить за сутки.

Формат запроса

Чтобы посмотреть параметры лимита запросов к API сервисов, используйте HTTP-запрос с методом GET:

GET /projects/<project_id>/services/<service_id>/limits
Host: api-developer.tech.yandex.net
X-Auth-Key: <ваш API-ключ>
Ресурс

<project_id>

Идентификатор проекта.

<service_id>

Идентификатор сервиса.

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

Host

Адрес узла, предоставляющего API.

X-Auth-Key

Ключ авторизации.

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит объект в формате JSON:

{
    "limits": {
        "pogoda_hits_daily": {
            "limit": 5000,
            "reset_date": "2019-02-06T21:00:00",
            "value": 0
        }
    }
}

Свойства ответа

Ключ

Значение

limits

Объект с информацией о лимите.

Свойства массива limits

pogoda_hits_daily

Объект с параметрами лимита.

Свойства массива pogoda_hits_daily

limit

Допустимое количество запросов.

Если сервис не имеет лимита запросов, параметр принимает значение -1.

reset_date

Дата и время прекращения действия лимита. По наступлении указанной даты отсчет количества запросов начнется заново.

Данные в формате:

YYYY-MM-DDThh:mm:ss

value

Количество отправленных запросов.

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

HTTP-код ошибки

Описание ошибки

400 Bad Request

Один из параметров запроса имеет недопустимое значение или формат данных.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

404 Not Found

Запрашиваемый ресурс не найден.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503 Service Unavailable

Сервис API временно недоступен.

Идентификатор проекта.

Адрес узла, предоставляющего API.

Ключ авторизации.

Идентификатор сервиса.