Ошибки в ответах
При отправке запросов к API Центрального Пульта, в ответе могут вернуться ошибки. В этой статье описаны эти ошибки, почему они могут возникнуть и возможные методы их решения.
400 Bad Request
Это ошибка возникает при указании неправильных параметров запроса, например, некорректное тело запроса. В этом случае, ответ будет выглядеть следующим образом:
{
"code": "InvalidContent",
"message": "Invalid JSON: Unexpected token @ in JSON at position 42"
}
Эта ошибка также может возникнуть, если не указать обязательные параметры пути запроса. В этом случае, ответ будет выглядеть следующим образом:
{
"code": "BadRequest",
"message": "Mandatory \"metrics\" parameter is absent/empty."
}
Описание в поле message
может помочь в определении причины ошибки.
401 Unauthorized
Эта ошибка возникает при проблемах с аутентификацией. У возникновения этой ошибки может быть несколько причн.
Not logged in
Эта ошибка возникает, если в запросе не укзаны параметры аутентификации. В этом случае, ответ будет выглядеть следующим образом:
{
"code": "Unauthorized",
"message": "{\"errorCode\":3,\"message\":\"Not logged in.\"}"
}
Session expired
Эта ошибка возникает при аутентификации с использованием Сессий, но Сессия с заданным ID не существует или была удалена. В этом случае, ответ будет выглядеть следующим образом:
{
"code": "Unauthorized",
"message": "{\"errorCode\":3,\"message\":\"Session expired.\"}"
}
Invalid login or password
Эта ошибка возникает при использовании базовой аутентификации, но указанные логин или пароль не верны. В этом случае, ответ будет выглядеть следующим образом:
{
"code": "InvalidCredentials",
"message": "{\"errorCode\":3,\"message\":\"Invalid login or password.\"}"
}
Invalid API token
Эта ошибка возникает при использовании Токена аутентификации, но указанный токен не существует или был удалён. В этом случае, ответ будет выглядеть следующим образом:
{
"code": "Unauthorized",
"message": "{\"errorCode\":3,\"message\":\"Invalid API token.\"}"
}
При возникновении одной из этих ошибок, проверьте правильность своих учетных данных для входа или убедитесь, что Сессия или Токен аутентификации не были удалены и все еще действительны.
403 Forbidden
Эта ошибка возникает, если у пользователя нет прав на выполнение запроса. В этом случае, ответ будет выглядеть следующим образом:
{
"code": "NotAuthorized",
"message": "User doesn't have required permission (expected one of: modify-objects, manage-objects)."
}
В поле message
указаны права, которые нужны для этого запроса.
При возникновении этой ошибки, обратитесь к администратору системы для того чтобы он проверил, есть ли у вас нужные права, и выдал их при необходимости.
404 Not Found
Эта ошибка возникает если вы делаете запрос, который требует указания ID сущности, но сущности с таким ID не существует. В этом случае, ответ будет выглядеть следующим образом:
{
"code": "ResourceNotFound",
"message": "Entity not found: User(42)"
}
При возникновении этой ошибки убедитесь, что ID указан правильно и сущность с этим ID существует.
409 Conflict
Эта ошибка возниает при передаче некорректного тела запроса (например, если не указать обязательно поле).
Пример ошибки, которая возникает, если не указать поле name
в теле запроса Создать класс.
{
"code": "InvalidArgument",
"message": "Field name required, entity=Class(undefined)"
}