API / Начало работы / Ошибки и коды ответа
Ошибки и коды ответа
Структура ответа с ошибкой
| Поле | Тип | Описание |
|---|---|---|
status | number | HTTP-статус ответа |
code | string | Короткий текстовый код для программной обработки, например token_scope_missing. Ориентируйтесь на него |
error | string | Описание по-английски для людей. Текст может меняться |
requestId | string | ID запроса, тот же, что в заголовке X-Request-ID. Приложите его к обращению в поддержку — так мы быстрее найдём ваш запрос |
Пример:
HTTP
HTTP/2 403 Forbidden
{
"status": 403,
"code": "token_scope_missing",
"error": "this API token lacks the servers:power scope",
"requestId": "3f1c9a2e-7b4d-4e8a-9c21-5d6e7f8a9b0c"
}HTTP-статусы
| Статус | Значение |
|---|---|
| 200 | Готово, в теле ответ |
| 201 | Создано |
| 204 | Готово, тела нет |
| 400 | Неверное тело или параметры |
| 401 | Нет токена, или он неверный, отозван, просрочен |
| 402 | Не хватает денег на балансе |
| 403 | Токену это нельзя: нет права, чужой проект, IP или лимит трат |
| 404 | Нет такого проекта, услуги или объекта |
| 409 | Конфликт состояния: сервер выключен, на ноде нет места, запрос ещё выполняется |
| 413 | Файл больше 1 МБ или не текст |
| 429 | Слишком много запросов, подождите Retry-After секунд |
| 503 | Панель или нода не ответили — повторите позже |
Коды ошибок
| Код | Статус | Что делать |
|---|---|---|
token_invalid | 401 | Токен неверный, отозван или просрочен — создайте новый |
token_route_forbidden | 403 | Метод недоступен по токену — сделайте это в браузере |
token_scope_missing | 403 | Добавьте токену право, указанное в error |
token_project_forbidden | 403 | Токен ограничен другими проектами или услугами |
token_ip_forbidden | 403 | Запрос с адреса, которого нет в списке токена |
token_spend_limit | 403 | Покупка превысит лимит трат токена — поднимите лимит |
insufficient_balance | 402 | Пополните баланс |
idempotency_key_required | 400 | Добавьте заголовок Idempotency-Key — см. лимиты и повторы |
idempotency_in_progress | 409 | Запрос с этим ключом ещё выполняется — подождите |
token_rate_limited | 429 | Подождите Retry-After секунд |
server_offline | 409 | Сервер не запущен |
node_full | 409 | На ноде нет места — выберите другую |
file_not_found | 404 | Нет такого файла или папки |
file_too_large | 413 | Файл больше 1 МБ — используйте SFTP |
path_invalid | 400 | Неверный путь к файлу |
upstream_unavailable | 503 | Повторите через минуту; не помогло — напишите в поддержку с requestId |
Если у ошибки нет своего кода, code повторяет статус: bad_request, forbidden, not_found, conflict и т. д.