Эта страница переведена машинным способом. Заметили ошибку?Помогите её улучшить.
Skip to content

Коды ошибок ​

Каждый ответ JSON с ошибкой имеет одинаковую структуру:

json
{
  "error": "Job not found",
  "code": "NOT_FOUND",
  "requestId": "req-42"
}
ПолеВсегда присутствуетЗначение
errorДаПонятное человеку сообщение. Его можно показывать пользователям. Не разбирайте его программно.
codeДаСтабильный машиночитаемый код. Ветвите логику по нему.
requestIdДаИдентификатор этого запроса на сервере. Указывайте его, когда сообщаете о проблеме: он совпадает с записью в журнале сервера.
detailsИногдаДополнительный контекст для некоторых ошибок 4xx, например сообщение о проверке.

Сообщения могут меняться между релизами. Коды не меняются, поэтому пишите клиентскую логику на основе code.

Коды по статусу HTTP ​

Если маршрут не задаёт собственный код, сервер выводит его из статуса:

Статус HTTPcode
400BAD_REQUEST
401AUTH_REQUIRED
403FORBIDDEN
404NOT_FOUND
409CONFLICT
413PAYLOAD_TOO_LARGE
415UNSUPPORTED_MEDIA_TYPE
422UNPROCESSABLE_ENTITY
429RATE_LIMITED
500INTERNAL_ERROR
501NOT_IMPLEMENTED
503SERVICE_UNAVAILABLE
507INSUFFICIENT_STORAGE

Любой другой статус 4xx получает BAD_REQUEST, а любой другой 5xx получает INTERNAL_ERROR.

Маршрут может задать более конкретный код, и тогда ответ содержит именно его. Например, инструмент, который не может запуститься из-за отсутствующего пакета ИИ, возвращает код, специфичный для функции. Эти коды описаны вместе с функцией, которая их вызывает.

Аутентификация и доступ ​

codeСтатусЧто делать
AUTH_REQUIRED401Передайте Authorization: Bearer <token> с токеном сессии или ключом API (si_...).
FORBIDDEN403Учётные данные действительны, но у них нет нужного разрешения. Попросите администратора выдать разрешение.
MUST_CHANGE_PASSWORD403Учётная запись должна сменить пароль, прежде чем вызывать другие эндпоинты. Вызовите POST /api/auth/change-password с токеном сессии, затем повторите запрос.
USER_DISABLED403Учётная запись отключена. Администратор должен снова включить её.
LOGIN_THROTTLED429Слишком много неудачных попыток входа. Подождите, прежде чем пробовать снова.
VALIDATION_ERROR400Тело запроса или параметры не прошли проверку. details указывает на проблему.

Учётная запись администратора первого запуска: admin с паролем admin, если только DEFAULT_USERNAME или DEFAULT_PASSWORD не изменили их. Если не задано SKIP_MUST_CHANGE_PASSWORD, эта учётная запись получает MUST_CHANGE_PASSWORD при каждом вызове, пока пароль не будет изменён.

Задания ​

Задание, завершившееся ошибкой, сообщает причину в самом задании, а не в ошибке HTTP. Прочитайте error.code и error.message из GET /api/v1/jobs/{jobId}. См. Отслеживание прогресса.

Пока не каталогизировано ​

Коды, которые вызываются отдельными функциями (например, шифрованием, OIDC, SCIM и командами), пока не описаны на этой странице. Каждый из них является стабильным кодом; относитесь к неперечисленному коду как к непрозрачному и обрабатывайте его по статусу.