CyberRXN Docs
API

Лимиты ключей со сбросом

День, неделя, календарный месяц и произвольные периоды вызовов и расходов.

Предсказуемая граница расхода

Используйте форму выпуска или настройки ключа в кабинете. Можно ограничить число вызовов, списание предоплаченных средств или оба показателя. Подходящие правила пространства и ключа действуют одновременно. Бонусный вызов учитывается в лимите числа вызовов; денежный лимит считает фактически списанные средства, а не условную стоимость включённой или бонусной квоты.

ПериодГраница
dailyКаждый день в00:00 UTC
weeklyПонедельник,00:00 UTC
monthlyНачало настоящего календарного месяца, UTC
customЯвный полуоткрытый интервал [starts_at, ends_at)

В произвольном периоде можно задать повторяющиеся окна от starts_at; последнее обрезается по ends_at. Вне заданного интервала ключ блокируется этим правилом. До начала периода расход не разрешается автоматически.

Контракт API

Собственная авторизованная сессия сайта может вызвать GET /v1/key-limits?key_id=... и PUT /v1/key-limits:

{"key_id":"YOUR_KEY_ID","period":"weekly","calls":1000,"budget_microusd":null}

budget_microusd — целое число микро-долларов США: 1000000 означает 1 USD. Оба поля calls и budget_microusd могут быть null; оба null удаляют только правило выбранного периода. Ноль — действующий запрет, а не отсутствующее значение.

Для custom нужны UTC ISO-время starts_at, ends_at и необязательный reset_interval_seconds от 60 до 31622400. Это длительность от явного начала, а не условный календарный месяц.

Ответ показывает window_start, window_end, active, resets_at, использованные и оставшиеся вызовы/средства, автора изменения и can_manage. Используйте фактическое время сброса: месяц нельзя считать всегда равным30 дням.

Резервирование и права

При допуске расход резервируется атомарно. Ожидающие и успешные вызовы учитываются, ошибки освобождают резерв, бесплатные гайд/репорты/статусы не расходуют тарифицируемую квоту правила. Окна вычисляются по истории; задача cron не стирает счётчики для сброса.

Владелец и администратор управляют ключами пространства. Разработчик может ограничить собственный ключ, но не отменить правило администратора. Достигнутый лимит возвращает key_limit_reached; retryable и Retry-After указываются, только когда будущий автоматический сброс действительно поможет. Нулевой лимит или истёкший фиксированный период требуют изменения правила, а не повторов.

GET /v1/key-limits без фильтра возвращает до 100 правил. Для точной проверки одного ключа укажите key_id. PUT возвращает правила изменённого ключа. Фиксированный произвольный период блокирует ключ после ends_at; окончание периода не отменяет лимит автоматически.

На этой странице