Стандартные коды ошибок:
Ошибка | Значение |
unspecified | Тип ошибки не указан. Подробности смотрите в сообщении. |
invalid_api_key | Указан неправильный ключ доступа к API. Проверьте, совпадает ли значение api_key со значением, указанным в личном кабинете. |
access_denied | Доступ запрещён. Проверьте, включён ли доступ к API в личном кабинете и не обращаетесь ли вы к методу, прав доступа к которому у вас нет. |
unknown_method | Указано неправильное имя метода. |
invalid_arg | Указано неправильное значение одного из аргументов метода. |
not_enough_money | Не хватает денег на счету для выполнения метода. |
retry_later | Временный сбой. Попробуйте ещё раз позднее. |
api_call_limit_exceeded_for_api_key | Сработало ограничение по вызову методов API в единицу времени. На данный момент это 1200 вызовов в минуту. Для метода sendEmail — 60. |
api_call_limit_exceeded_for_ip | Сработало ограничение по вызову методов API в единицу времени. На данный момент это 1200 вызовов в минуту. Для метода sendEmail — 60. |
Частые ошибки без указания типа:
Ошибка | Значение |
«These list ids=»…» has no confirmation letters» | Не создано письмо подтверждение для списка, на который подписывается адресат. Откройте в личном кабинете список контактов на который настроена подписка, внизу слева есть пункт «Инструменты подписки и отписки». Заполните все поля на этой странице и сохраните. Инструкция по созданию письма подтверждения. |
“Contacts test@example.org and +77777777 already exist but owned by different subscribers” | Вы добавляете email и телефон контакта, который уже есть в вашем кабинете. Укажите email или телефон, который не принадлежит другому адресату. |
«Call to a member function getMessage() on boolean» | Вызов осуществляется с одновременным использованием методов GET и POST. Выполняйте запрос только одним из данных методов. |
Кроме этих ошибок, могут быть и другие, указанные в описаниях конкретных методов.
Пример ответа с ошибкой:
{"error":"AK100310-02","code":"invalid_api_key"}
Время на прочтение
5 мин
Количество просмотров 5.6K
Содержание
-
1. Простой случай
-
2. Случай клиента
-
3. В чем проблема?
-
4. Решение проблем
-
5. Итог
Простой случай
Как правило проблема с доступом к API OpenCart возникает когда не настроен доступ по API.
Для решения этой проблемы нужно пройти в админке в Система-Пользователи-API
, зайти в нужный объект списка и добавить свой IP адрес в список.
Либо на странице, с сообщением о проблеме с API просто нажать на кнопку Добавить IP-адрес
и обновить страницу.
Но у нашего клиента на OpenCart 2.3 было не все так просто …
Случай клиента
Перед началом разработки модуля клиент сообщил мне, что в админке на странице редактирования заказа у него часто/рандомно не работает изменение заказа: У вас нет разрешения на доступ к API!
А как позже выяснилось, такая проблема у клиента на 2 сайтах, где используется одна и та же версия OpenCart 2.3, сайты размещены у одного и того же хостера.
Изначально я не придал этому значения, так как проблема у клиента была до меня, а сроки по разработке были крайне сжатые (как обычно), а значит ее решение это второстепенная задача, однако на этапе внедрения модуля в интернет-магазин клиента начались проблемы.
Дело в том, что интерфейс функциональности разработанного мной модуля располагался на странице редактирования заказа, во вкладке Товары
, а из-за проблем доступа к API клиент не мог проверить работу модуля. Но это была первая часть проблемы. Как выяснилось позже мой модуль не мог корректно функционировать, так как использовал доступ к заказу основываясь на API.
Стоит уточнить, что интерфейс редактирования заказа во многом построен на Ajax API OpenCart, с использованием авторизации и получением токена для доступа к API.
Первым делом я перепроверил ajax запросы на корретность работы, как на клиенте так и на сервере. Токен на клиенте есть, проверка токена и авторизация по токену на сервере есть. Все также как и у API запросов, но не работает …
В чем проблема?
В другой статье мы уже вкратце разбирали Ajax API, а теперь копнем глубже.
Посмотрим контроллер catalog/controller/api/login.php
(запрос получения токена для работы с API /index.php?route=api/login
), в случае валидного API key
и наличия в этой группе IP адреса выполняющего (того кто делает запрос), данный запрос стартует новую сессию с именем api
с единственным ключом api_id
:
$session_id_new = $this->session->createId();
$this->session->start('api', $session_id_new);
$this->session->data['api_id'] = $api_info['api_id'];
Затем посмотрим catalog/controller/startup/session.php
(это первичный контроллер, который запускается при любом запросе в catalog
, до основного контроллера), здесь при наличии токена полученного в предыдущем запросе происходит старт сессии с именем api
:
$this->session->start('api', $query->row['session_id']);
А теперь пройдем в файл с классом сессии system/library/session.php
и смотрим метод start
:
public function start($key = 'default', $value = '') {
if ($value) {
$this->session_id = $value;
} elseif (isset($_COOKIE[$key])) {
$this->session_id = $_COOKIE[$key];
} else {
$this->session_id = $this->createId();
}
if (!isset($_SESSION[$this->session_id])) {
$_SESSION[$this->session_id] = array();
}
$this->data = &$_SESSION[$this->session_id];
//...
}
На основании предыдущих файлов можно сказать: session_id
может быть взят из куки api
, а данные сессии можно получить по session_id
.
Вспоминаем что API запросы OpenCart проверяют валидность доступа в catalog
контекст по токену следующим образом:
if (!isset($this->session->data['api_id'])) {
$json['error']['warning'] = $this->language->get('error_permission');
} else {
...
}
И приходим к понимаю того, что с сессией проблемы, хотя судя по коду должно быть все ровно.
Для того чтобы понять в чем проблема, можно попробовать записывать данные $_SESSION
в файл в запросе получения токена (после его получения), и при первом API запросе в файле catalog/controller/startup/session.php
прямо перед или после старта api
сессии.
В итоге я увидел что:
Сессия с
session_id
создается на этапе авторизации и в нее записывается один единственный ключapi_key
, но уже при следующем запросе к API, массив данных сессии с этимsession_id
пуст, но заполняется при отработке всех контроллеров указанных в массивеaction_pre_action
(в файлеsystem/config/catalog.php
) и данные сессии сохраняются.Однако при этом в нем отсутствует ключ
api_id
, без которого дальнейшая работа с API невозможна и поэтому мы видим сообщение: У вас нет разрешения на доступ к API!
Решение проблем
Почему возникает данная проблема мне не удалось выяснить. Развернув точную копию сайта клиента у себя на локальном сервере, воспроизвести проблему не получилось.
После обращения клиента в ТП хостинга, проблема исчезла на некоторое время (в это же время я пытался решить ее самостоятельно, но безуспешно, ибо не воспроизводилось), а потом благополучно, примерно через сутки, проблема вернулась.
Повторный дебаг $_SESSION
не дал результатов, все также: при запросе авторизации создавалась новая сессия с ключом api_id
, а при следующем обращении к API эта новая сессия была пуста.
Понимая что данные сессии не могут сохранится в $_SESSION
при запросе авторизации снова смотрим catalog/controller/startup/session.php
и видим запрос к БД:
$query = $this->db->query("SELECT DISTINCT * FROM `" . DB_PREFIX . "api` `a` LEFT JOIN `" . DB_PREFIX . "api_session` `as` ON (a.api_id = as.api_id) LEFT JOIN " . DB_PREFIX . "api_ip `ai` ON (as.api_id = ai.api_id) WHERE a.status = '1' AND as.token = '" . $this->db->escape($this->request->get['token']) . "' AND ai.ip = '" . $this->db->escape($this->request->server['REMOTE_ADDR']) . "'");
Если этот запрос возвращает не пустой массив, значит можно считать что авторизация прошла успешно, а среди выбранных из БД данных есть api_id
.
В catalog/controller/startup/session.php
сразу после старта сессии пишем:
if ($query->num_rows) {
$this->session->start('api', $query->row['session_id']);
//это может решить проблему с доступом по апи
$this->session->data["api_id"] = $query->row["api_id"];
//...
}
И проблема У вас нет разрешения на доступ к API! решена!
Для решения проблемы У вас нет разрешения на доступ к API! в данном случае достаточно после старта сессии в
catalog/controller/startup/session.php
вставить в массив сессии ключapi_id
:$this->session->data["api_id"] = $query->row["api_id"];
Для убедительности я провел тест: получил ошибку У вас нет разрешения на доступ к API!, а затем применил описанное выше решение и не перезагружая страницы (где была ошибка) провел несколько ajax запросов к API OpenCart, которые прошли успешно.
Итог
Клиент доволен, оба сайта работают, проблема решена. Однако, источник проблемы не выявлен, есть несколько предположений, возможно как-нибудь проверю.
Автор: Виталий Бутурлин
Содержание:
- Общие сведения
- Формат ошибок
- Формат ответа методов API в случае ошибок
- Структура ответа
- Описание параметров
- Формат ответа методов API в случае ошибок
- Описание общих ошибок API
Общие сведения
В документе описан формат ошибок методов API, а также приведен перечень общих ошибок, которые могут возникать при обращении к методам API.
Формат ошибок
Формат ответа методов API в случае ошибок
Структура ответа
- JSON
- XML
{ "metadata":{ "status":400, "detail":"abc", "generated_at":"2015-06-18 12:37:28" }, "errors":[ { "code":281016, "title":"ошибка упрощённой отправки", "detail":"контрагент с минимальным набором данных не может быть отправителем по заказу", "link":"https://dev.dellin.ru/api/ordering/request/#error_281016", "fields":["receiver"] }, { "code":281017, "title":"Недопустимое значение параметра", "detail":"Данный параметр может содержать только значения из списка доступных значений", "link":"https://dev.dellin.ru/api/ordering/request/#error_281017", "fields":["requester"], "validValues":[1, 2, 3] }, { "code":117004, "title":"значение не найдено в справочнике", "detail":"необходимо выбрать значение из соответствующего справочника", "link":"https://dev.dellin.ru/calculation/pickup/#error_117004", "fields":["requester"], "badValues":["0xa77fcf6a449164ed490133777a68bd00"] } ] }
<response> <metadata> <status>400</status> <detail>abc</detail> <generated_at>2015-06-18 12:37:28</generated_at> </metadata> <errors> <code>281016</code> <title>ошибка упрощённой отправки</title> <detail>контрагент с минимальным набором данных не может быть отправителем по заказу</detail> <link>https://dev.dellin.ru/api/ordering/request/#error_281016</link> <fields>receiver</fields> </errors> <errors> <code>281017</code> <title>Недопустимое значение параметра</title> <detail>Данный параметр может содержать только значения из списка доступных значений</detail> <link>https://dev.dellin.ru/api/ordering/request/#error_281017</link> <fields>requester</fields> <validValues>1</validValues> <validValues>2</validValues> <validValues>3</validValues> </errors> <errors> <code>117004</code> <title>значение не найдено в справочнике</title> <detail>необходимо выбрать значение из соответствующего справочника</detail> <link>https://dev.dellin.ru/calculation/pickup/#error_117004</link> <fields>requester</fields> <badValues>0xa77fcf6a449164ed490133777a68bd00</badValues> </errors> </response>
Описание параметров
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Информация об оформленной заявке |
metadata.status | integer |
Эмуляция http-кода состояния |
metadata.detail | string | Текстовое описание ответа сервера |
metadata.generated_at | string | Дата и время генерации ответа сервера |
errors | array of Response.Errors | Перечень ошибок |
Response.Errors | ||
---|---|---|
Параметр | Тип | Описание |
code | integer | Номер ошибки |
title | string |
Краткое описание ошибки |
detail | string | Детальное описание ошибки |
link | string | Ссылка на документацию |
fields | array of string | Список параметров в запросе к методу, вызвавших ошибку |
validValues | array of string | Список доступных значений параметра |
badValues | array of string | Список ошибочных значений, переданных в параметре |
Номер ошибки | http-код | Краткое описание ошибки | Детальное описание ошибки |
---|---|---|---|
100001 |
415 | Некорректный content-type | Допустимые значения content-type: application/json (стандарт RFC4627) и text/xml (стандарт RFC3023) |
100002 |
404 | Метод не найден | Проверьте правильность адреса метода |
100003 |
410 | Метод отключен | Запрошенный метод более не доступен |
100004 |
403 | Отсутствует доступ к методу | Доступ к методу предоставляется по требованию. Для получения доступа обратитесь к персональному менеджеру или в техническую поддержку |
100005 |
429 | Количество запросов к превышено | Превышена допустимая частота запросов. Для увеличения лимита обратитесь к персональному менеджеру или в техническую поддержку |
100006 |
500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
101001 |
401 | Требуется авторизация | Не передан API-ключ |
101002 |
401 | Требуется авторизация | Передан недействительный API-ключ |
101003 |
401 | Требуется авторизация | Требуется передать параметр sessionID |
101004 |
401 | Требуется авторизация | Время жизни сессии истекло |
101005 |
401 | Требуется авторизация | Сессия не найдена или создана с другим API-ключом |
101006 |
401 | Требуется авторизация | Неверный логин или пароль |
101007 |
401 | Требуется авторизация | API-ключ заблокирован. Обратитесь в техническую поддержку |
101008 |
401 | Ошибка парсинга | Запрос не соответствует формату json |
101009 |
401 | Ошибка парсинга | Запрос не соответствует формату xml |
110001 |
400 | Неверный формат параметра | Значение, переданное в параметре, не соответствует требуемому формату |
110002 |
400 | Ошибка типизации | Значение, переданное в параметре, имеет некорректный тип |
110003 |
400 | Отсутствует обязательный параметр | Отсутствует обязательный параметр |
110004 |
400 | Не передан ни один из обязательных параметров | В запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одного |
110005 |
400 | Допустима передача только одного из параметров | Указаны взаимоисключающие параметры, только один из которых может присутствовать в запросе |
110006 |
400 | Превышено ограничение на длину списка | Количество элементов в списке превышает максимально допустимое |
110007 |
400 | Объект не существует | Не найден объект с указанным ID. Проверьте правильность переданного значения |
110008 |
400 | Недопустимый набор параметров | Указанные параметры не должны участвовать в запросе |
120001 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomers не отвечает) |
120002 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomers вернул неизвестную ошибку) |
120101 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomersV2 не отвечает) |
120102 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomersV2 вернул неизвестную ошибку) |
120201 |
400 | Ошибка в параметрах запроса |
Переданы неправильные параметры в запрос (Причина: Переданы некорректные данные в getOrdersTracker) |
120301 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис getPaymentsByOrders не отвечает) |
121001 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
121002 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
130001 |
500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
130002 |
400 | Ошибка выполнения запроса | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130003 |
400 | Указан некорректный документ, удостоверяющий личность | Проверьте правильность переданных значений |
130004 |
400 | Не передан ни один из обязательных параметров |
В запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одного |
130005 |
400 | Отсутствует обязательный параметр | Отсутствует обязательный параметр |
130006 |
400 | Значение превышает допустимое | Габариты превышают допустимые размеры |
130007 |
400 | Неверный формат параметра | Значение, переданное в параметре, не соответствует требуемому формату |
130008 |
400 |
Недопустимое значение параметра | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130009 |
400 | Превышено ограничение на длину значения | Превышена максимально допустимая длина значения поля |
130010 |
400 | Отсутствует согласие с тарифами и правилами перевозки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130014 |
400 | Ошибка наложенного платежа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130015 |
400 | Ошибка оформления услуги | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130017 |
400 | Невозможно оформить заявку на указанное время | — |
130021 |
400 | Услуга недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130022 |
400 | Указан некорректный адрес | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130023 |
400 | Выбран недопустимый терминал | Выбран недопустимый терминал |
130024 |
400 | Превышено ограничение на длину списка | Превышено максимальное количество контрагентов в адресной книге (10000). Необходимо удалить часть записей или обратиться в службу поддержки |
150001 |
500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
150002 |
500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
180001 |
400 | Указан некорректный документ, удостоверяющий личность | Проверьте правильность переданных значений |
180002 |
400 | Указан некорректный адрес | Указан некорректный адрес |
180003 |
400 | Выбран недопустимый терминал | Выбранный терминал не может принять груз с указанными ВГХ |
180004 |
400 | Услуга недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180005 |
400 | Значение превышает допустимое | Весогабаритные характеристики груза превышают допустимые для приёма на терминалах города |
180006 |
400 | Ошибка в параметрах запроса | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180007 |
400 | Недопустимое значение параметра | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180008 |
400 | Ошибка упрощенной отправки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180009 |
400 | Ошибка оформления услуги Доставка в день заказа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180010 |
400 | Ошибка оформления услуги Доставка в точное время | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180011 |
400 | Указан некорректный период работы | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180012 |
400 | Выбранная дата недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180013 |
400 | Ошибка параметров оплаты | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180014 |
400 | Ошибка наложенного платежа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180015 |
400 | Ошибка оформления услуги | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180016 |
400 | Ошибка при сохранении заявки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180017 |
400 | Невозможно оформить заявку на указанное время | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
Коды статусов и ошибок
Коды состояния и ошибок — это число в заголовке ответа, который указывает общую классификацию ответа — например, был ли запрос успешным (200), привел ли к ошибке сервера (500), были ли проблемы с авторизацией (403), и так далее. Стандартные коды состояния обычно не требуют большого количества документации, но пользовательские коды состояния и ошибки, специфичные для API, нужны. Коды ошибок, в частности, помогают в устранении неисправных запросов.
Содержание раздела
Пример кода статуса в заголовке curl
Где перечислять HTTP-ответ и коды ошибок
Где взять коды статусов и ошибок
Как перечислить коды состояния
Коды состояния и ошибок помогают в устранении неполадок
Примеры кодов статусов и шибок
-
Context.io
-
Twitter
-
Mailchimp
-
Flickr
Практическое занятие: Коды статусов и ошибок
Пример кода статуса в заголовке curl
Коды статусов не отображаются в тебе ответа. Они содержатся в хэдере, который может быть не видим по умолчанию.
Помните, когда мы отправляли обратный вызов в разделе Создание curl запроса? Чтобы получить заголовок ответа, добавляем —include или -i к запросу curl. Если нужно, чтобы в ответе возвращался только заголовок ответа (и ничего больше), используем заглавную букву -I, например:
curl -I -X GET "https://api.openweathermap.org/data/2.5/weather?zip=95050&appid=fd4698c940c6d1da602a70ac34f0b147&units=imperial"
Заголовок ответа выглядит следующим образом:
HTTP/1.1 200 OK Server: openresty Date: Thu, 06 Dec 2018 22:58:41 GMT Content-Type: application/json; charset=utf-8 Content-Length: 446 Connection: keep-alive X-Cache-Key: /data/2.5/weather?units=imperial&zip=95050 Access-Control-Allow-Origin: * Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST
Первая строка, HTTP / 1.1 200 OK
, сообщает нам статус запроса (200
). Большинство API REST следуют стандартному протоколу для заголовков ответов. Например, 200
— это не просто произвольный код, выбранный разработчиками OpenWeatherMap API. 200
— это общепринятый код для успешного HTTP-запроса. (Если изменить метод, то получим другой код состояния.)
С помощью запроса GET довольно легко определить, успешен ли запрос, потому что получаем ожидаемый ответ. Но предположим, делаем запрос POST, PUT или DELETE, когда мы меняем данные, содержащиеся в ресурсе. Как узнать, был ли запрос успешно обработан и получен API? Коды ответа HTTP в заголовке ответа будут указывать, была ли операция успешной. Коды состояния HTTP — это просто сокращения длинных сообщений.
Коды состояния довольно тонкие, но когда разработчик работает с API, коды могут быть единственным «интерфейсом», который имеет разработчик. Если получится контролировать сообщения, которые видит разработчик, это будет большой победой юзабилити.
Слишком часто коды состояния неинформативны, плохо написаны и сообщают мало или вообще никакой полезной информации пользователю для преодоления ошибки. По большому счету, коды состояния должны помогать пользователям в восстановлении после ошибок.
Можно посмотреть список общих кодов состояния REST API здесь и общий список кодов HTTP статусов здесь. Хотя, возможно, было бы полезно включить несколько стандартных кодов состояния, нет необходимости в полном документировании всех стандартных кодов состояния, особенно если они редко запускаются в API.
Где перечислять HTTP-ответ и коды ошибок
Практичнее, если API будут иметь одну страницу с ответами и кодами ошибок ко всему API. Отдельная страница с перечнем кодов состояния (вместо добавления кода состояния в каждую конечную точку) позволяет более детально описать каждый код без переполнения других частей документации. Такой подход уменьшает избыточность и ощущение информационной перегрузки.
С другой стороны, если какие-то коды состояния и ошибок больше подходят к определенным конечным точкам, чем другие, имеет смысл вывести такие коды состояния и ошибок на страницы с описаниями конечных точек.
Такая стратегия может заключаться в том, чтобы привлечь внимание к каким-либо особенно важным кодам состояния или ошибок для конкретной конечной точки, а затем перейти к централизованной странице «Коды ответов и состояний» для получения полной информации.
Где взять коды статусов и шибок
Коды состояния и ошибок могут быть неочевидны в документации API. Вероятно, придется попросить разработчиков предоставить список всех кодов состояния и ошибок, которые уникальны для API. Иногда разработчики хардкодят коды состояния и ошибок непосредственно в программном коде, и у них нет простых способов передать полный список (что также затрудняет локализацию).
В результате может потребоваться танцы с бубнами, чтобы найти все коды. В частности, возможно придется сломать API, чтобы увидеть все возможные коды ошибок. Например, если превысить ограничение скорости для определенного запроса, API может вернуть специальную ошибку или код состояния. Такой пользовательский код обязательно нужно задокументировать. В разделе устранения неполадок в API можно специально разместить примеры получения кодов ошибок.
Как перечислить коды состояния
Коды статусов и ошибок можно привести в виде списка определений или таблицы, например так:
Status code | Значение |
---|---|
200 |
Успешный запрос и ответ |
400 |
Неверно заданные параметры или другой неверный запрос |
Коды состояния и ошибок помогают в устранении неполадок
Коды состояния и ошибок особенно полезны при устранения неполадок. Таким образом, можно рассматривать коды ошибок как дополнение к разделу по устранению неполадок.
Каждая часть документации может быть полезна в разделе, посвященном устранению неполадок. В разделе, посвященном устранению неполадок, можно описать, что происходит, когда пользователи уходят с проторенной дорожки и спотыкаются в темном лесу. Коды состояния похожи на подсказки, которые помогут пользователям вернуться на правильный путь.
В разделе по устранению неполадок можно перечислить сообщения об ошибках, связанных со следующими ситуациями:
- использование неправильных API ключей;
- использование неверных API ключей;
- параметры не соответствуют типам данных;
- API выдает исключение;
- нет данных для возврата ресурса;
- превышен предел скорости;
- параметры находятся за пределами приемлемых максимальной и минимальной границ;
- обязательный параметр отсутствует в конечной точке.
текст ошибки должен точно документироваться, чтобы она легко появлялась при поиске.
Примеры кодов статусов и ошибок
Ниже приведены несколько вариантов разделов с кодами статусов и ошибок.
Context.io
Коды статусов и ошибок Conext.io
Clearbit не только документирует стандартные коды состояния, но также описывает уникальные параметры, возвращаемые их API. Большинство разработчиков, вероятно, знакомы с кодами 200, 400 и 500, поэтому эти коды не требуют много пояснений. Но если API имеет уникальные коды, описывать их нужно адекватно и подробно.
Коды статусов и ошибок Twitter
В Twitter не только описывается код и состояние, но также предоставляется полезная информация по устранению неполадок, потенциально помогая в устранении ошибок. Например, про ошибку 500
не просто сказано, что статус относится к неработающей службе, но и есть объяснение: «Обычно это временная ошибка, например, в ситуации высокой нагрузки или если у конечной точки временно возникают проблемы. Посетите форумы разработчиков на случай, если у других возникнут аналогичные проблемы, или повторите попытку позже».
Полезные сообщения такого рода — то, к чему должны стремиться технические писатели в разделе кодов состояния (по крайней мере, делать описания тех кодов, которые указывают на проблемы)
Mailchimp
Коды статусов и ошибок Mailchimp
Mailchimp предоставляет удобочитаемые и понятные описания сообщений об ошибке. Например, в ошибке 403
вместо того, чтобы просто написать «Запрещено», Mailchimp объясняет причины, по которым можно получить ошибку запрещенного кода. У Mailchimp существует несколько типов ошибок 403. Запрос может быть запрещен из-за отключенной учетной записи пользователя или запроса, направленного не в тот центр обработки данных. В случае ошибки «WrongDataCenter» Mailchimp отмечает, что «она часто связана с неправильно настроенными библиотеками» и ссылается на дополнительную информацию о центрах обработки данных. Такой тип документации кода ошибки очень полезен для пользователей.
Flickr
Коды статусов и ошибок Flikr
В Flickr раздел «Коды ответов» встроен в описание каждой адресной темы API. Описания ошибок выглядят короткими. Хотя встраивание кодов ответов в каждую тему делает коды ошибок более заметными, в некоторых случаях такой подход менее полезен. Поскольку он встроен в каждую тему API, описания кодов ошибок должны быть краткими, иначе их содержимое будет перегружено информацией о запросе конечной точки.
Напротив, отдельная страница с перечнем кодов ошибок позволяет более подробно раскрывать каждый код, не вытесняя другую документацию. Отдельная страница также уменьшает избыточность и увеличивает объем информации.
👨💻 Практическое занятие: Коды статусов и ошибок
В своем найденном опен-сорс проекте найдем информацию о кодах статусов и ошибок. Ответим на следующие вопросы:
- присутствуют описания кодов статусов и ошибок в проекте?
- где находится информация о кодах статусов и ошибок в контексте документации? Как отдельная тема? Ниже каждой конечной точки? Где-нибудь еще?
- имеет ли API какой-либо уникальный код статусов и ошибок?
- помогают ли коды ошибок пользователям восстанавливаться после ошибок?
- сделаем запрос на одну из конечных точек, затем целенаправленно изменим параметр, чтобы сделать недействительный запрос. Какой код статуса возвращается в ответе? Этот код состояния задокументирован?
🔙
Go next ➡
REST API использует строку состояния в HTTP ответе (статус ответа), чтобы информировать Клиентов о результате запроса.
Вообще HTTP определяет 40 стандартных кодов состояния (статусов ответа), которые делятся на пять категорий. Ниже выделены только те коды состояния, которые часто используются в REST API.
Категория | Описание |
---|---|
1xx: Информация | В этот класс содержит заголовки информирующие о процессе передачи. Это обычно предварительный ответ, состоящий только из Status-Line и опциональных заголовков, и завершается пустой строкой. Нет обязательных заголовков. Серверы НЕ ДОЛЖНЫ посылать 1xx ответы HTTP/1.0 клиентам. |
2xx: Успех | Этот класс кодов состояния указывает, что запрос клиента был успешно получен, понят, и принят. |
3xx: Перенаправление | Коды этого класса сообщают клиенту, что для успешного выполнения операции необходимо сделать другой запрос, как правило, по другому URI. Из данного класса пять кодов 301, 302, 303, 305 и 307 относятся непосредственно к перенаправлениям. |
4xx: Ошибка клиента | Класс кодов 4xx предназначен для указания ошибок со стороны клиента. |
5xx: Ошибка сервера | Коды ответов, начинающиеся с «5» указывают на случаи, когда сервер знает, что произошла ошибка или он не может обработать запрос. |
Коды состояний в REST
Звездочкой *
помечены популярные (часто используемые) коды ответов.
200 * (OK)
Запрос выполнен успешно. Информация, возвращаемая с ответом зависит от метода, используемого в запросе, например при:
- GET Получен объект, соответствующий запрошенному ресурсу.
- HEAD Получены поля заголовков, соответствующие запрошенному ресурсу, тело ответа пустое.
- POST Запрошенное действие выполнено.
201 * (Created — Создано)
REST API отвечает кодом состояния 201 при каждом создании ресурса в коллекции. Также могут быть случаи, когда новый ресурс создается в результате какого-либо действия контроллера, и в этом случае 201 также будет подходящем ответом.
Ссылка (URL) на новый ресурс может быть в теле ответа или в поле заголовка ответа Location.
Сервер должен создать ресурс перед тем как вернуть 201 статус. Если это невозможно сделать сразу, тогда сервер должен ответить кодом 202 (Accepted).
202 (Accepted — Принято)
Ответ 202 обычно используется для действий, которые занимают много времени для обработки и не могут быть выполнены сразу. Это означает, что запрос принят к обработке, но обработка не завершена.
Его цель состоит в том, чтобы позволить серверу принять запрос на какой-либо другой процесс (возможно, пакетный процесс, который выполняется только один раз в день), не требуя, чтобы соединение агента пользователя с сервером сохранялось до тех пор, пока процесс не будет завершен.
Сущность, возвращаемая с этим ответом, должна содержать указание на текущее состояние запроса и указатель на монитор состояния (расположение очереди заданий) или некоторую оценку того, когда пользователь может ожидать выполнения запроса.
203 (Non-Authoritative Information — Неавторитетная информация)
Предоставленная информация взята не из оригинального источника (а, например, из кэша, который мог устареть, или из резервной копии, которая могла потерять актуальность). Этот факт отражен в заголовке ответа и подтверждается этим кодом. Предоставленная информация может совпадать, а может и не совпадать с оригинальными данными.
204 * (No Content — Нет контента)
Код состояния 204 обычно отправляется в ответ на запрос PUT, POST или DELETE, когда REST API отказывается отправлять обратно любое сообщение о состоянии проделанной работы.
API может также отправить 204 статус в ответ на GET запрос, чтобы указать, что запрошенный ресурс существует, но не имеет данных для добавления их в тело ответа.
Ответ 204 не должен содержать тело сообщения и, таким образом, всегда завершается первой пустой строкой после полей заголовка.
205 — (Reset Content — Сброшенное содержимое)
Сервер успешно обработал запрос и обязывает клиента сбросить введенные пользователем данные. В ответе не должно передаваться никаких данных (в теле ответа). Обычно применяется для возврата в начальное состояние формы ввода данных на клиенте.
206 — (Partial Content — Частичное содержимое)
Сервер выполнил часть GET запроса ресурса. Запрос ДОЛЖЕН был содержать поле заголовка Range (секция 14.35), который указывает на желаемый диапазон и МОГ содержать поле заголовка If-Range (секция 14.27), который делает запрос условным.
Запрос ДОЛЖЕН содержать следующие поля заголовка:
- Либо поле Content-Range (секция 14.16), который показывает диапазон, включённый в этот запрос, либо Content-Type со значением multipart/byteranges, включающими в себя поля Content-Range для каждой части. Если в заголовке запроса есть поле Content-Length, его значение ДОЛЖНО совпадать с фактическим количеством октетов, переданных в теле сообщения.
- Date
- ETag и/или Content-Location, если ранее был получен ответ 200 на такой же запрос.
- Expires, Cache-Control, и/или Vary, если значение поля изменилось с момента отправления последнего такого же запроса
Если ответ 206 — это результат выполнения условного запроса, который использовал строгий кэш-валидатор (подробнее в секции 13.3.3), в ответ НЕ СЛЕДУЕТ включать какие-либо другие заголовки сущности. Если такой ответ — результат выполнения запроса If-Range, который использовал «слабый» валидатор, то ответ НЕ ДОЛЖЕН содержать другие заголовки сущности; это предотвращает несоответствие между закэшированными телами сущностей и обновлёнными заголовками. В противном случае ответ ДОЛЖЕН содержать все заголовки сущностей, которые вернули статус 200 (OK) на тот же запрос.
Кэш НЕ ДОЛЖЕН объединять ответ 206 с другими ранее закэшированными данными, если поле ETag или Last-Modified в точности не совпадают (подробнее в секции 16.5.4)
Кэш, который не поддерживает заголовки Range и Content-Range НЕ ДОЛЖЕН кэшировать ответы 206 (Partial).
300 — (Multiple Choices — Несколько вариантов)
По указанному URI существует несколько вариантов предоставления ресурса по типу MIME, по языку или по другим характеристикам. Сервер передаёт с сообщением список альтернатив, давая возможность сделать выбор клиенту автоматически или пользователю.
Если это не запрос HEAD, ответ ДОЛЖЕН включать объект, содержащий список характеристик и адресов, из которого пользователь или агент пользователя может выбрать один наиболее подходящий. Формат объекта определяется по типу данных приведённых в Content-Type поля заголовка. В зависимости от формата и возможностей агента пользователя, выбор наиболее подходящего варианта может выполняться автоматически. Однако эта спецификация не определяет никакого стандарта для автоматического выбора.
Если у сервера есть предпочтительный выбор представления, он ДОЛЖЕН включить конкретный URI для этого представления в поле Location; агент пользователя МОЖЕТ использовать заголовок Location для автоматического перенаправления к предложенному ресурсу. Этот запрос может быть закэширован, если явно не было указано иного.
301 (Moved Permanently — Перемещено навсегда)
Код перенаправления. Указывает, что модель ресурсов REST API была сильно изменена и теперь имеет новый URL. Rest API должен указать новый URI в заголовке ответа Location
, и все будущие запросы должны быть направлены на указанный URI.
Вы вряд ли будете использовать этот код ответа в своем API, так как вы всегда можете использовать версию API для нового API, сохраняя при этом старый.
302 (Found — Найдено)
Является распространенным способом выполнить перенаправление на другой URL. HTTP-ответ с этим кодом должен дополнительно предоставит URL-адрес куда перенаправлять в поле заголовка Location. Агенту пользователя (например, браузеру) предлагается в ответе с этим кодом сделать второй запрос на новый URL.
Многие браузеры реализовали этот код таким образом, что нарушили стандарт. Они начали изменять Тип исходного запроса, например с POST на GET. Коды состояния 303 и 307 были добавлены для серверов, которые хотят однозначно определить, какая реакция ожидается от клиента.
303 (See Other — Смотрите другое)
Ответ 303 указывает, что ресурс контроллера завершил свою работу, но вместо отправки нежелательного тела ответа он отправляет клиенту URI ресурса. Это может быть URI временного сообщения о состоянии ресурса или URI для уже существующего постоянного ресурса.
Код состояния 303 позволяет REST API указать ссылку на ресурс, не заставляя клиента загружать ответ. Вместо этого клиент может отправить GET запрос на URL указанный в заголовке Location
.
Ответ 303 не должен кэшироваться, но ответ на второй (перенаправленный) запрос может быть кэшируемым.
304 * (Not Modified — Не изменен)
Этот код состояния похож на 204 (Нет контента), так как тело ответа должно быть пустым. Ключевое различие состоит в том, что 204 используется, когда нет ничего для отправки в теле, тогда как 304 используется, когда ресурс не был изменен с версии, указанной заголовками запроса If-Modified-Since
или If-None-Match
.
В таком случае нет необходимости повторно передавать ресурс, так как у клиента все еще есть ранее загруженная копия.
Все это экономит ресурсы клиента и сервера, так как только заголовки должны быть отправлены и приняты, и серверу нет необходимости генерировать контент снова, а клиенту его получать.
305 — (Use Proxy — Используйте прокси)
Доступ к запрошенному ресурсу ДОЛЖЕН быть осуществлен через прокси-сервер, указанный в поле Location. Поле Location предоставляет URI прокси. Ожидается, что получатель повторит этот запрос с помощью прокси. Ответ 305 может генерироваться ТОЛЬКО серверами-источниками.
Заметьте: в спецификации RFC 2068 однозначно не сказано, что ответ 305 предназначен для перенаправления единственного запроса, и что он должен генерироваться только сервером-источником. Упущение этих ограничений вызвало ряд значительных последствий для безопасности.
Многие HTTP клиенты (такие, как Mozilla и Internet Explorer) обрабатывают этот статус некорректно прежде всего из соображений безопасности.
307 (Temporary Redirect — Временный редирект)
Ответ 307 указывает, что rest API не будет обрабатывать запрос клиента. Вместо этого клиент должен повторно отправить запрос на URL, указанный в заголовке Location
. Однако в будущих запросах клиент по-прежнему должен использоваться исходный URL.
Rest API может использовать этот код состояния для назначения временного URL запрашиваемому ресурсу.
Если метод запроса не HEAD, тело ответа должно содержать короткую заметку с гиперссылкой на новый URL. Если код 307 был получен в ответ на запрос, отличный от GET или HEAD, Клиент не должен автоматически перенаправлять запрос, если он не может быть подтвержден Клиентом, так как это может изменить условия, при которых был создан запрос.
308 — (Permanent Redirect — Постоянное перенаправление) (experimental)
Нужно повторить запрос на другой адрес без изменения применяемого метода.
Этот и все последующие запросы нужно повторить на другой URI. 307 и 308 (как предложено) Схож в поведении с 302 и 301, но не требуют замены HTTP метода. Таким образом, например, отправку формы на «постоянно перенаправленный» ресурс можно продолжать без проблем.
400 * (Bad Request — Плохой запрос)
Это общий статус ошибки на стороне Клиента. Используется, когда никакой другой код ошибки 4xx не уместен. Ошибки могут быть как неправильный синтаксис запроса, неверные параметры запроса, запросы вводящие в заблуждение или маршрутизатор и т.д.
Клиент не должен повторять точно такой же запрос.
401 * (Unauthorized — Неавторизован)
401 сообщение об ошибке указывает, что клиент пытается работать с закрытым ресурсом без предоставления данных авторизации. Возможно, он предоставил неправильные учетные данные или вообще ничего. Ответ должен включать поле заголовка WWW-Authenticate
, содержащего описание проблемы.
Клиент может повторить запрос указав в заголовке подходящее поле авторизации. Если это уже было сделано, то в ответе 401 будет указано, что авторизация для указанных учетных данных не работает. Если в ответе 401 содержится та же проблема, что и в предыдущем ответе, и Клиент уже предпринял хотя бы одну попытку проверки подлинности, то пользователю Клиента следует представить данные полученные в ответе, владельцу сайта, так как они могут помочь в диагностике проблемы.
402 — (Payment Required — Требуется оплата)
Этот код зарезервирован для использования в будущем.
Предполагается использовать в будущем. В настоящий момент не используется. Этот код предусмотрен для платных пользовательских сервисов, а не для хостинговых компаний. Имеется в виду, что эта ошибка не будет выдана хостинговым провайдером в случае просроченной оплаты его услуг. Зарезервирован, начиная с HTTP/1.1.
403 * (Forbidden — Запрещено)
Ошибка 403 указывает, что rest API отказывается выполнять запрос клиента, т.е. Клиент не имеет необходимых разрешений для доступа. Ответ 403 не является случаем, когда нужна авторизация (для ошибки авторизации используется код 401).
Попытка аутентификация не поможет, и повторные запросы не имеют смысла.
404 * (Not Found — Не найдено)
Указывает, что rest API не может сопоставить URL клиента с ресурсом, но этот URL может быть доступен в будущем. Последующие запросы клиента допустимы.
404 не указывает, является ли состояние временным или постоянным. Для указания постоянного состояния используется код 410 (Gone — Пропал). 410 использоваться, если сервер знает, что старый ресурс постоянно недоступен и более не имеет адреса.
405 (Method Not Allowed — Метод не разрешен)
API выдает ошибку 405, когда клиент пытался использовать HTTP метод, который недопустим для ресурса. Например, указан метод PUT, но такого метода у ресурса нет.
Ответ 405 должен включать Заголовок Allow
, в котором перечислены поддерживаемые HTTP методы, например, Allow: GET, POST
.
406 (Not Acceptable — Неприемлемый)
API не может генерировать предпочитаемые клиентом типы данных, которые указаны в заголовке запроса Accept
. Например, запрос клиента на данные в формате application/xml
получит ответ 406, если API умеет отдавать данные только в формате application/json
.
В таких случаях Клиент должен решить проблему данных у себя и только потом отправлять запросы повторно.
407 — (Proxy Authentication Required — Требуется прокси-аутентификация)
Ответ аналогичен коду 401, за исключением того, что аутентификация производится для прокси-сервера. Механизм аналогичен идентификации на исходном сервере.
Пользователь должен сначала авторизоваться через прокси. Прокси-сервер должен вернуть Proxy-Authenticate заголовок, содержащий запрос ресурса. Клиент может повторить запрос вместе с Proxy-Authenticate заголовком. Появился в HTTP/1.1.
408 — (Request Timeout — Таймаут запроса)
Время ожидания сервером передачи от клиента истекло. Клиент не предоставил запрос за то время, пока сервер был готов его принят. Клиент МОЖЕТ повторить запрос без изменений в любое время.
Например, такая ситуация может возникнуть при загрузке на сервер объёмного файла методом POST или PUT. В какой-то момент передачи источник данных перестал отвечать, например, из-за повреждения компакт-диска или потери связи с другим компьютером в локальной сети. Пока клиент ничего не передаёт, ожидая от него ответа, соединение с сервером держится. Через некоторое время сервер может закрыть соединение со своей стороны, чтобы дать возможность другим клиентам сделать запрос.
409 * (Conflict — Конфликт)
Запрос нельзя обработать из-за конфликта в текущем состоянии ресурса. Этот код разрешается использовать только в тех случаях, когда ожидается, что пользователь может самостоятельно разрешить этот конфликт и повторить запрос. В тело ответа СЛЕДУЕТ включить достаточное количество информации для того, чтобы пользователь смог понять причину конфликта. В идеале ответ должен содержать такую информацию, которая поможет пользователю или его агенту исправить проблему. Однако это не всегда возможно и это не обязательно.
Как правило, конфликты происходят во время PUT-запроса. Например, во время использования версионирования, если сущность, к которой обращаются методом PUT, содержит изменения, конфликтующие с теми, что были сделаны ранее третьей стороной, серверу следует использовать ответ 409, чтобы дать понять пользователю, что этот запрос нельзя завершить. В этом случае в ответной сущности должен содержаться список изменений между двумя версиями в формате, который указан в поле заголовка Content-Type.
410 — (Gone — Исчез)
Такой ответ сервер посылает, если ресурс раньше был по указанному URL, но был удалён и теперь недоступен. Серверу в этом случае неизвестно и местоположение альтернативного документа, например, копии. Если у сервера есть подозрение, что документ в ближайшее время может быть восстановлен, то лучше клиенту передать код 404. Появился в HTTP/1.1.
411 — (Length Required — Требуется длина)
Для указанного ресурса клиент должен указать Content-Length в заголовке запроса. Без указания этого поля не стоит делать повторную попытку запроса к серверу по данному URI. Такой ответ естественен для запросов типа POST и PUT. Например, если по указанному URI производится загрузка файлов, а на сервере стоит ограничение на их объём. Тогда разумней будет проверить в самом начале заголовок Content-Length и сразу отказать в загрузке, чем провоцировать бессмысленную нагрузку, разрывая соединение, когда клиент действительно пришлёт слишком объёмное сообщение.
412 — (Precondition Failed — Предварительное условие не выполнено)
Возвращается, если ни одно из условных полей заголовка запроса не было выполнено.
Когда клиент указывает rest API выполнять запрос только при выполнении определенных условий, а API не может выполнить запрос при таких условиях, то возвращается ответ 412.
Этот код ответа позволяет клиенту записывать предварительные условия в метаинформации текущего ресурса, таким образом, предотвращая применение запрошенного метода к ресурсу, кроме того, что ожидается.
413 — (Request Entity Too Large — Сущность запроса слишком большая)
Возвращается в случае, если сервер отказывается обработать запрос по причине слишком большого размера тела запроса. Сервер может закрыть соединение, чтобы прекратить дальнейшую передачу запроса.
Если проблема временная, то рекомендуется в ответ сервера включить заголовок Retry-After с указанием времени, по истечении которого можно повторить аналогичный запрос.
414 — (Request-URI Too Long — Запрос-URI Слишком длинный)
Сервер не может обработать запрос из-за слишком длинного указанного URL. Эту редкую ошибку можно спровоцировать, например, когда клиент пытается передать длинные параметры через метод GET, а не POST, когда клиент попадает в «чёрную дыру» перенаправлений (например, когда префикс URI указывает на своё же окончание), или когда сервер подвергается атаке со стороны клиента, который пытается использовать дыры в безопасности, которые встречаются на серверах с фиксированной длиной буфера для чтения или обработки Request-URI.
415 (Unsupported Media Type — Неподдерживаемый медиа тип)
Сообщение об ошибке 415 указывает, что API не может обработать предоставленный клиентом Тип медиа, как указано в заголовке запроса Content-Type
.
Например, запрос клиента содержит данные в формате application/xml
, а API готов обработать только application/json
. В этом случае клиент получит ответ 415.
Например, клиент загружает изображение как image/svg+xml
, но сервер требует, чтобы изображения использовали другой формат.
428 — (Precondition Required — Требуется предварительное условие)
Код состояния 428 указывает, что исходный сервер требует, чтобы запрос был условным.
Его типичное использование — избежать проблемы «потерянного обновления», когда клиент ПОЛУЧАЕТ состояние ресурса, изменяет его и ОТПРАВЛЯЕТ обратно на сервер, когда тем временем третья сторона изменила состояние на сервере, что привело к конфликту. Требуя, чтобы запросы были условными, сервер может гарантировать, что клиенты работают с правильными копиями.
Ответы с этим кодом состояния ДОЛЖНЫ объяснять, как повторно отправить запрос.
429 — (Too Many Requests — Слишком много запросов)
Пользователь отправил слишком много запросов за заданный промежуток времени.
Представления ответа ДОЛЖНЫ включать подробности, объясняющие условие, и МОГУТ включать заголовок Retry-After, указывающий, как долго ждать, прежде чем делать новый запрос.
431 — (Request Header Fields Too Large — Слишком большие поля заголовка запроса)
Код состояния 431 указывает на то, что сервер не желает обрабатывать запрос, поскольку его поля заголовка слишком велики. Запрос МОЖЕТ быть отправлен повторно после уменьшения размера полей заголовка запроса.
Его можно использовать как в случае, когда совокупность полей заголовка запроса слишком велика, так и в случае неисправности одного поля заголовка. В последнем случае представление ответа ДОЛЖНО указывать, какое поле заголовка было слишком большим.
444 — (No Response — Нет ответа) (Nginx)
Код ответа Nginx. Сервер не вернул информацию и закрыл соединение. (полезно в качестве сдерживающего фактора для вредоносных программ)
451 — (Unavailable For Legal Reasons — Недоступен по юридическим причинам)
Доступ к ресурсу закрыт по юридическим причинам. Наиболее близким из существующих является код 403 Forbidden (сервер понял запрос, но отказывается его обработать). Однако в случае цензуры, особенно когда это требование к провайдерам заблокировать доступ к сайту, сервер никак не мог понять запроса — он его даже не получил. Совершенно точно подходит другой код: 305 Use Proxy. Однако такое использование этого кода может не понравиться цензорам. Было предложено несколько вариантов для нового кода, включая «112 Emergency. Censorship in action» и «460 Blocked by Repressive Regime»
500 * (Internal Server Error — Внутренняя ошибка сервера)
Общий ответ при ошибке в коде. Универсальное сообщение о внутренней ошибке сервера, когда никакое более определенное сообщение не подходит.
Большинство веб-платформ автоматически отвечают этим кодом состояния, когда при выполнении кода обработчика запроса возникла ошибка.
Ошибка 500 никогда не зависит от клиента, поэтому для клиента разумно повторить точно такой же запрос, и надеяться что в этот раз сервер отработает без ошибок.
501 (Not Implemented — Не реализован)
Серверу либо неизвестен метод запроса, или ему (серверу) не хватает возможностей выполнить запрос. Обычно это подразумевает будущую доступность (например, новая функция API веб-сервиса).
Если же метод серверу известен, но он не применим к данному ресурсу, то нужно вернуть ответ 405.
502 — (Bad Gateway — Плохой шлюз)
Сервер, выступая в роли шлюза или прокси-сервера, получил некорректный ответ от вышестоящего сервера, к которому он обратился. Появился в HTTP/1.0.
503 — (Service Unavailable — Служба недоступна)
Сервер не может обработать запрос из-за временной перегрузки или технических работ. Это временное состояние, из которого сервер выйдет через какое-то время. Если это время известно, то его МОЖНО передать в заголовке Retry-After.
504 — (Gateway Timeout — Таймаут шлюза)
Сервер, в роли шлюза или прокси-сервера, не дождался в рамках установленного таймаута ответа от вышестоящего сервера текущего запроса.
505 — (HTTP Version Not Supported — Версия HTTP не поддерживается)
Сервер не поддерживает или отказывается поддерживать указанную в запросе версию протокола HTTP.
510 — (Not Extended — Не расширен)
В запросе не соблюдена политика доступа к ресурсу. Сервер должен отправить обратно всю информацию, необходимую клиенту для отправки расширенного запроса. Указание того, как расширения информируют клиента, выходит за рамки данной спецификации.
—
Источники и более подробная информация:
- https://restapitutorial.ru/httpstatuscodes.html
- https://www.restapitutorial.com/httpstatuscodes.html
- https://restfulapi.net/http-status-codes/
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428
В этом документе указаны некоторые коды ошибок и сообщения о них, получаемые от API Google. В список включены те ошибки, которые относятся к глобальному (используемому по умолчанию) домену для API Google. Многие API также определяют собственные домены, в которых могут быть свои ошибки, отсутствующие в глобальном домене. У таких ошибок в ответе JSON будет указано значение свойства domain
, относящееся к конкретному API, например youtube.parameter
.
На этой странице перечислены ошибки, систематизированные по кодам статуса HTTP, определения которых приведены в спецификации RFC 7231.
Вот пример ответа JSON, передающего информацию об ошибке, относящейся к глобальному домену:
{ "error": { "errors": [ { "domain": "global", "reason": "invalidParameter", "message": "Invalid string value: 'asdf'. Allowed values: [mostpopular]", "locationType": "parameter", "location": "chart" } ], "code": 400, "message": "Invalid string value: 'asdf'. Allowed values: [mostpopular]" } }
Ошибки
- MOVED_PERMANENTLY (301)
- SEE_OTHER (303)
- NOT_MODIFIED (304)
- TEMPORARY_REDIRECT (307)
- BAD_REQUEST (400)
- UNAUTHORIZED (401)
- PAYMENT_REQUIRED (402)
- FORBIDDEN (403)
- NOT_FOUND (404)
- METHOD_NOT_ALLOWED (405)
- CONFLICT (409)
- GONE (410)
- PRECONDITION_FAILED (412)
- REQUEST_ENTITY_TOO_LARGE (413)
- REQUESTED_RANGE_NOT_SATISFIABLE (416)
- EXPECTATION_FAILED (417)
- PRECONDITION_REQUIRED (428)
- TOO_MANY_REQUESTS (429)
- INTERNAL_SERVER_ERROR (500)
- NOT_IMPLEMENTED (501)
- SERVICE_UNAVAILABLE (503)
MOVED_PERMANENTLY (301)
Код ошибки | Описание |
---|---|
movedPermanently |
Запрос был отправлен на URL, который больше нельзя использовать. Все запросы для той же операции теперь необходимо отправлять на URL, указанный в заголовке Location полученного ответа. |
SEE_OTHER (303)
Код ошибки | Описание |
---|---|
seeOther |
Запрос успешно обработан. Чтобы получить ответ, отправьте запрос GET на URL, указанный в заголовке Location . |
mediaDownloadRedirect |
Запрос успешно обработан. Чтобы получить ответ, отправьте запрос GET на URL, указанный в заголовке Location . |
NOT_MODIFIED (304)
Код ошибки | Описание |
---|---|
notModified |
Условие, заданное для заголовка If-None-Match, не было выполнено. Этот ответ означает, что запрошенный документ не был изменен и что должен быть получен кешированный ответ. Проверьте значение заголовка If-None-Match в HTTP-запросе. |
TEMPORARY_REDIRECT (307)
Код ошибки | Описание |
---|---|
temporaryRedirect |
Чтобы ваш запрос был обработан, повторно отправьте его на URL, указанный в заголовке Location этого ответа. |
BAD_REQUEST (400)
Код ошибки | Описание |
---|---|
badRequest |
Запрос к API недействителен или неправильно сформирован. Поэтому сервер API не может его распознать. |
badBinaryDomainRequest |
Двоичный запрос к домену недействителен. |
badContent |
Тип данных запроса или тип контента части пакетного запроса не поддерживается. |
badLockedDomainRequest |
Запрос к заблокированному домену недействителен. |
corsRequestWithXOrigin |
Запрос CORS содержит заголовок X-Origin XD3, то есть этот запрос составлен неправильно. |
endpointConstraintMismatch |
Обработать запрос не удалось, так как он не соответствует указанному API. Убедитесь, что вы указали правильный URL. |
invalid |
Обработать запрос не удалось, так как он содержал недопустимое значение. Это может быть значение параметра, заголовка или свойства. |
invalidAltValue |
В значении параметра alt указан неизвестный формат вывода. |
invalidHeader |
Обработать запрос не удалось, так как он содержал недопустимый заголовок. |
invalidParameter |
Обработать запрос не удалось, так как он содержал недопустимый параметр или значение параметра. Чтобы определить, какие параметры можно использовать для запроса, изучите документацию API. |
invalidQuery |
Запрос недействителен. Узнайте, какие параметры можно использовать для запроса, и убедитесь, что запрос не содержит недопустимую комбинацию параметров или недействительные значения параметров. Для этого изучите документацию API. Проверьте значение параметра q . |
keyExpired |
Срок действия ключа API, указанного в запросе, истек. Это означает, что сервер API не может проверить лимит квоты для приложения, отправляющего запрос. Чтобы узнать больше или получить новый ключ, перейдите в Google Developers Console. |
keyInvalid |
Указанный в запросе ключ API недействителен. Это означает, что сервер API не может проверить лимит квоты для приложения, отправляющего запрос. Попробуйте найти ключ с помощью Google Developers Console или получите новый. |
lockedDomainCreationFailure |
Токен OAuth был получен в строке запроса. API запрещает это для всех форматов ответа, кроме JSON и XML. Попробуйте отправить токен OAuth в заголовке Authorization. |
notDownload |
На URL типа /download/* могут быть отправлены только запросы на скачивание мультимедиа. Отправьте запрос на тот же адрес, но без префикса /download . |
notUpload |
На URI с префиксом /upload/* можно отправлять только запросы на загрузку. Ваш запрос не относится к их числу, поэтому обработать его не удалось. Отправьте запрос на тот же адрес, но без префикса /upload . |
parseError |
Сервер API не может обработать тело запроса. |
required |
В запросе отсутствует обязательная информация. Возможно, это параметр или свойство ресурса. |
tooManyParts |
Обработать пакетный запрос не удалось, так как в нем слишком много частей. |
unknownApi |
API, к которому обращается запрос, не распознан. |
unsupportedMediaProtocol |
Медиапротокол клиента не поддерживается. |
unsupportedOutputFormat |
В значении параметра alt указан формат вывода, который не поддерживается этим сервисом. Проверьте значение параметра запроса alt . |
wrongUrlForUpload |
Обработать запрос на загрузку не удалось из-за неправильного URI. Такие запросы можно отправлять только на URI с префиксом /upload/* . Отправьте запрос на тот же адрес, но с префиксом /upload . |
Код ошибки | Описание |
---|---|
unauthorized |
У пользователя нет прав для выполнения этого запроса. |
authError |
Для запроса указаны неправильные учетные данные. Проверьте значение заголовка Authorization в HTTP-запросе. |
expired |
Время сеанса истекло. Проверьте значение заголовка Authorization в HTTP-запросе. |
lockedDomainExpired |
Обработать запрос не удалось, так как истек срок действия заблокированного домена. |
required |
Для выполнения этого запроса к API пользователю необходимо войти в систему. Проверьте значение заголовка Authorization в HTTP-запросе. |
PAYMENT_REQUIRED (402)
Код ошибки | Описание |
---|---|
dailyLimitExceeded402 |
Достигнут дневной лимит бюджета, установленный разработчиком. |
quotaExceeded402 |
Для запрошенной операции необходимо больше ресурсов, чем доступно по квоте. Чтобы выполнить эту операцию, требуется платеж. |
user402 |
Чтобы выполнить запрошенную операцию, требуется платеж от аутентифицированного пользователя. |
FORBIDDEN (403)
Код ошибки | Описание |
---|---|
forbidden |
Запрошенная операция запрещена, и ее нельзя завершить. |
accessNotConfigured |
Для вашего проекта не настроен доступ к этому API. Активируйте API для проекта в Google Developers Console. |
accessNotConfigured |
Проект заблокирован из-за нарушения правил. См. http://support.google.com/code/go/developer_compliance. |
accessNotConfigured |
Проект подлежит удалению. |
accountDeleted |
Аккаунт, связанный с указанными в запросе учетными данными, был удален. Проверьте значение заголовка Authorization в HTTP-запросе. |
accountDisabled |
Аккаунт, связанный с указанными в запросе учетными данными, был отключен. Проверьте значение заголовка Authorization в HTTP-запросе. |
accountUnverified |
Адрес электронной почты пользователя, делающего запрос, не подтвержден. Проверьте значение заголовка Authorization в HTTP-запросе. |
concurrentLimitExceeded |
Обработать запрос не удалось, так как достигнут лимит параллельных соединений. |
dailyLimitExceeded |
Достигнут ежедневный лимит квоты для API. |
dailyLimitExceeded |
Достигнут ежедневный лимит квоты, и проект заблокирован из-за нарушения правил. Подробную информацию можно найти на форуме поддержки по правилам API Google. |
dailyLimitExceededUnreg |
Обработать запрос не удалось, так как достигнут предел анонимного использования API в день. Чтобы продолжить работу с API, войдите в Google Developers Console. |
downloadServiceForbidden |
API не поддерживает скачивание. |
insufficientAudience |
Запрос не может быть выполнен для этой аудитории. |
insufficientAuthorizedParty |
Запрос не может быть выполнен для этого приложения. |
insufficientPermissions |
У аутентифицированного пользователя недостаточно прав для выполнения этого запроса. |
limitExceeded |
Запрос нельзя выполнить из-за ограничений по доступу или частоте. |
lockedDomainForbidden |
API не поддерживает заблокированные домены. |
quotaExceeded |
Для запрошенной операции необходимо больше ресурсов, чем доступно по квоте. |
rateLimitExceeded |
В течение определенного промежутка времени было отправлено слишком много запросов. |
rateLimitExceededUnreg |
Превышен лимит частоты запросов. Чтобы продолжить использование API, зарегистрируйте приложение. Для этого создайте аккаунт, используя Google Developers Console. |
responseTooLarge |
Невозможно получить запрошенный ресурс, так как его размер слишком велик. |
servingLimitExceeded |
Достигнут лимит на частоту запросов для этого API. |
sslRequired |
Эта операция возможна только с применением SSL. |
unknownAuth |
Сервер API не распознает схему авторизации, используемую для запроса. Проверьте значение заголовка Authorization в HTTP-запросе. |
userRateLimitExceeded |
Обработать запрос не удалось, так как частота запросов от этого пользователя превышает допустимую. |
userRateLimitExceededUnreg |
Обработать запрос не удалось, так как достигнут предел частоты запросов от этого пользователя и в запросе не указан разработчик клиента. Создайте проект для вашего приложения в Google Developer Console (https://console.developers.google.com). |
variableTermExpiredDailyExceeded |
Обработать запрос не удалось, так как истек срок действия временной квоты и была исчерпана стандартная дневная. |
variableTermLimitExceeded |
Обработать запрос не удалось, так как была исчерпана временная квота, действующая в указанный период. |
NOT_FOUND (404)
Код ошибки | Описание |
---|---|
notFound |
Не удалось выполнить операцию, так как не найден ресурс, указанный в запросе. |
notFound |
Не найден ресурс, указанный в запросе. Если вы не пользовались этим API в последние две недели, выполните повторное развертывание приложения App Engine и попробуйте вызвать API ещё раз. |
unsupportedProtocol |
Не поддерживается протокол, используемый в запросе. |
METHOD_NOT_ALLOWED (405)
Код ошибки | Описание |
---|---|
httpMethodNotAllowed |
Не поддерживается метод HTTP, связанный с запросом. |
CONFLICT (409)
Код ошибки | Описание |
---|---|
conflict |
Не удалось выполнить запрос к API, так как запрошенная операция может вызвать конфликт с уже существующим объектом. Например, это случается, если запрашивается создание повторяющегося элемента, однако при таких конфликтах, как правило, ошибки диагностируются более конкретно. |
duplicate |
Не удалось выполнить запрошенную операцию, так как она требует создания уже существующего ресурса. |
GONE (410)
Код ошибки | Описание |
---|---|
deleted |
Обработать запрос не удалось, так как указанный в нем ресурс был удален. |
PRECONDITION_FAILED (412)
Код ошибки | Описание |
---|---|
conditionNotMet |
Не было выполнено условие, заданное для заголовка If-Match или If-None-Match в HTTP-запросе. Чтобы узнать больше, прочитайте раздел ETag спецификации HTTP. Проверьте значение заголовка If-Match . |
REQUEST_ENTITY_TOO_LARGE (413)
Код ошибки | Описание |
---|---|
backendRequestTooLarge |
Слишком большой запрос. |
batchSizeTooLarge |
Пакетный запрос содержит слишком много элементов. |
uploadTooLarge |
Обработать запрос не удалось, так как в нем слишком много данных. |
REQUESTED_RANGE_NOT_SATISFIABLE (416)
Код ошибки | Описание |
---|---|
requestedRangeNotSatisfiable |
В запросе указан недопустимый диапазон. |
EXPECTATION_FAILED (417)
Код ошибки | Описание |
---|---|
expectationFailed |
Сервер не может выполнить запрос клиента. |
PRECONDITION_REQUIRED (428)
Код ошибки | Описание |
---|---|
preconditionRequired |
Запрос должен содержать условие. Укажите в запросе заголовки If-Match или If-None-Match , чтобы он был успешно обработан. |
TOO_MANY_REQUESTS (429)
Код ошибки | Описание |
---|---|
rateLimitExceeded |
В течение определенного промежутка времени отправлено слишком много запросов. |
INTERNAL_SERVER_ERROR (500)
Код ошибки | Описание |
---|---|
internalError |
Не удалось обработать запрос из-за внутренней ошибки. |
NOT_IMPLEMENTED (501)
Код ошибки | Описание |
---|---|
notImplemented |
Запрошенная операция не была реализована. |
unsupportedMethod |
Обработать запрос не удалось, так как для этого необходимо выполнить неизвестный метод или операцию. |
SERVICE_UNAVAILABLE (503)
Код ошибки | Описание |
---|---|
backendError |
Произошла ошибка серверного кода. |
backendNotConnected |
Обработать запрос не удалось из-за ошибки подключения. |
notReady |
Сервер API не готов принимать запросы. |
Ошибки, связанные непосредственно с Indexing API
Во всех описанных ниже ситуациях запрос отклоняется, а Googlebot не сканирует соответствующий URL. То же происходит в случае основных ошибок.
BAD_REQUEST (400)
Сообщение об ошибке | Описание |
---|---|
Missing attribute. 'url' attribute is required. |
Пользователь не указал URL в запросе. |
Invalid attribute. 'url' is not in standard URL format |
Пользователь ввел некорректный URL, например «abcd». |
Unknown type. 'type' attribute is required and must be 'URL_REMOVED' or 'URL_UPDATED'. |
Пользователь не указал тип уведомления. |
Invalid value at 'url_notification.type' (TYPE_ENUM) |
Пользователь указал в типе уведомления не URL_REMOVED или URL_UPDATED , а другое значение. |
FORBIDDEN (403)
Сообщение об ошибке | Описание |
---|---|
Permission denied. Failed to verify the URL ownership. |
Пользователь не прошел процедуру подтверждения права собственности или пытается обновить URL, который ему не принадлежит. |
TOO_MANY_REQUESTS (429)
Сообщение об ошибке | Описание |
---|---|
Insufficient tokens for quota 'indexing.googleapis.com/default_requests' |
Пользователь исчерпал свою квоту Indexing API. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-03-29 UTC.
Содержание:
- Общие сведения
- Формат ошибок
- Формат ответа методов API в случае ошибок
- Структура ответа
- Описание параметров
- Формат ответа методов API в случае ошибок
- Описание общих ошибок API
Общие сведения
В документе описан формат ошибок методов API, а также приведен перечень общих ошибок, которые могут возникать при обращении к методам API.
Формат ошибок
Формат ответа методов API в случае ошибок
Структура ответа
- JSON
- XML
{ "metadata":{ "status":400, "detail":"abc", "generated_at":"2015-06-18 12:37:28" }, "errors":[ { "code":281016, "title":"ошибка упрощённой отправки", "detail":"контрагент с минимальным набором данных не может быть отправителем по заказу", "link":"https://dev.dellin.ru/api/ordering/request/#error_281016", "fields":["receiver"] }, { "code":281017, "title":"Недопустимое значение параметра", "detail":"Данный параметр может содержать только значения из списка доступных значений", "link":"https://dev.dellin.ru/api/ordering/request/#error_281017", "fields":["requester"], "validValues":[1, 2, 3] }, { "code":117004, "title":"значение не найдено в справочнике", "detail":"необходимо выбрать значение из соответствующего справочника", "link":"https://dev.dellin.ru/calculation/pickup/#error_117004", "fields":["requester"], "badValues":["0xa77fcf6a449164ed490133777a68bd00"] } ] }
<response> <metadata> <status>400</status> <detail>abc</detail> <generated_at>2015-06-18 12:37:28</generated_at> </metadata> <errors> <code>281016</code> <title>ошибка упрощённой отправки</title> <detail>контрагент с минимальным набором данных не может быть отправителем по заказу</detail> <link>https://dev.dellin.ru/api/ordering/request/#error_281016</link> <fields>receiver</fields> </errors> <errors> <code>281017</code> <title>Недопустимое значение параметра</title> <detail>Данный параметр может содержать только значения из списка доступных значений</detail> <link>https://dev.dellin.ru/api/ordering/request/#error_281017</link> <fields>requester</fields> <validValues>1</validValues> <validValues>2</validValues> <validValues>3</validValues> </errors> <errors> <code>117004</code> <title>значение не найдено в справочнике</title> <detail>необходимо выбрать значение из соответствующего справочника</detail> <link>https://dev.dellin.ru/calculation/pickup/#error_117004</link> <fields>requester</fields> <badValues>0xa77fcf6a449164ed490133777a68bd00</badValues> </errors> </response>
Описание параметров
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Информация об оформленной заявке |
metadata.status | integer |
Эмуляция http-кода состояния |
metadata.detail | string | Текстовое описание ответа сервера |
metadata.generated_at | string | Дата и время генерации ответа сервера |
errors | array of Response.Errors | Перечень ошибок |
Response.Errors | ||
---|---|---|
Параметр | Тип | Описание |
code | integer | Номер ошибки |
title | string |
Краткое описание ошибки |
detail | string | Детальное описание ошибки |
link | string | Ссылка на документацию |
fields | array of string | Список параметров в запросе к методу, вызвавших ошибку |
validValues | array of string | Список доступных значений параметра |
badValues | array of string | Список ошибочных значений, переданных в параметре |
Описание общих ошибок API
Номер ошибки | http-код | Краткое описание ошибки | Детальное описание ошибки |
---|---|---|---|
100001 |
415 | Некорректный content-type | Допустимые значения content-type: application/json (стандарт RFC4627) и text/xml (стандарт RFC3023) |
100002 |
404 | Метод не найден | Проверьте правильность адреса метода |
100003 |
410 | Метод отключен | Запрошенный метод более не доступен |
100004 |
403 | Отсутствует доступ к методу | Доступ к методу предоставляется по требованию. Для получения доступа обратитесь к персональному менеджеру или в техническую поддержку |
100005 |
429 | Количество запросов к превышено | Превышена допустимая частота запросов. Для увеличения лимита обратитесь к персональному менеджеру или в техническую поддержку |
100006 |
500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
101001 |
401 | Требуется авторизация | Не передан API-ключ |
101002 |
401 | Требуется авторизация | Передан недействительный API-ключ |
101003 |
401 | Требуется авторизация | Требуется передать параметр sessionID |
101004 |
401 | Требуется авторизация | Время жизни сессии истекло |
101005 |
401 | Требуется авторизация | Сессия не найдена или создана с другим API-ключом |
101006 |
401 | Требуется авторизация | Неверный логин или пароль |
101007 |
401 | Требуется авторизация | API-ключ заблокирован. Обратитесь в техническую поддержку |
101008 |
401 | Ошибка парсинга | Запрос не соответствует формату json |
101009 |
401 | Ошибка парсинга | Запрос не соответствует формату xml |
110001 |
400 | Неверный формат параметра | Значение, переданное в параметре, не соответствует требуемому формату |
110002 |
400 | Ошибка типизации | Значение, переданное в параметре, имеет некорректный тип |
110003 |
400 | Отсутствует обязательный параметр | Отсутствует обязательный параметр |
110004 |
400 | Не передан ни один из обязательных параметров | В запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одного |
110005 |
400 | Допустима передача только одного из параметров | Указаны взаимоисключающие параметры, только один из которых может присутствовать в запросе |
110006 |
400 | Превышено ограничение на длину списка | Количество элементов в списке превышает максимально допустимое |
110007 |
400 | Объект не существует | Не найден объект с указанным ID. Проверьте правильность переданного значения |
110008 |
400 | Недопустимый набор параметров | Указанные параметры не должны участвовать в запросе |
120001 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomers не отвечает) |
120002 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomers вернул неизвестную ошибку) |
120101 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomersV2 не отвечает) |
120102 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис calculateCustomersV2 вернул неизвестную ошибку) |
120201 |
400 | Ошибка в параметрах запроса |
Переданы неправильные параметры в запрос (Причина: Переданы некорректные данные в getOrdersTracker) |
120301 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки (Причина: Сервис getPaymentsByOrders не отвечает) |
121001 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
121002 |
500 | Внутренняя ошибка сервера |
Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
130001 |
500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
130002 |
400 | Ошибка выполнения запроса | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130003 |
400 | Указан некорректный документ, удостоверяющий личность | Проверьте правильность переданных значений |
130004 |
400 | Не передан ни один из обязательных параметров |
В запросе должен присутствовать хотя бы один параметр из совокупности, однако не указано ни одного |
130005 |
400 | Отсутствует обязательный параметр | Отсутствует обязательный параметр |
130006 |
400 | Значение превышает допустимое | Габариты превышают допустимые размеры |
130007 |
400 | Неверный формат параметра | Значение, переданное в параметре, не соответствует требуемому формату |
130008 |
400 |
Недопустимое значение параметра | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130009 |
400 | Превышено ограничение на длину значения | Превышена максимально допустимая длина значения поля |
130010 |
400 | Отсутствует согласие с тарифами и правилами перевозки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130014 |
400 | Ошибка наложенного платежа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130015 |
400 | Ошибка оформления услуги | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130017 |
400 | Невозможно оформить заявку на указанное время | — |
130021 |
400 | Услуга недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130022 |
400 | Указан некорректный адрес | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
130023 |
400 | Выбран недопустимый терминал | Выбран недопустимый терминал |
130024 |
400 | Превышено ограничение на длину списка | Превышено максимальное количество контрагентов в адресной книге (10000). Необходимо удалить часть записей или обратиться в службу поддержки |
150001 |
500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
150002 |
500 | Внутренняя ошибка сервера | Попробуйте вызвать метод через некоторое время. При повторении ошибки обратитесь в службу поддержки |
180001 |
400 | Указан некорректный документ, удостоверяющий личность | Проверьте правильность переданных значений |
180002 |
400 | Указан некорректный адрес | Указан некорректный адрес |
180003 |
400 | Выбран недопустимый терминал | Выбранный терминал не может принять груз с указанными ВГХ |
180004 |
400 | Услуга недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180005 |
400 | Значение превышает допустимое | Весогабаритные характеристики груза превышают допустимые для приёма на терминалах города |
180006 |
400 | Ошибка в параметрах запроса | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180007 |
400 | Недопустимое значение параметра | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180008 |
400 | Ошибка упрощенной отправки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180009 |
400 | Ошибка оформления услуги Доставка в день заказа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180010 |
400 | Ошибка оформления услуги Доставка в точное время | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180011 |
400 | Указан некорректный период работы | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180012 |
400 | Выбранная дата недоступна | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180013 |
400 | Ошибка параметров оплаты | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180014 |
400 | Ошибка наложенного платежа | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180015 |
400 | Ошибка оформления услуги | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180016 |
400 | Ошибка при сохранении заявки | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
180017 |
400 | Невозможно оформить заявку на указанное время | Детальное описание ошибки содержит уточняющую информацию. Текст варьируется в зависимости от проверяемого параметра |
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
В этом документе указаны некоторые коды ошибок и сообщения о них, получаемые от API Google. В список включены те ошибки, которые относятся к глобальному (используемому по умолчанию) домену для API Google. Многие API также определяют собственные домены, в которых могут быть свои ошибки, отсутствующие в глобальном домене. У таких ошибок в ответе JSON будет указано значение свойства domain
, относящееся к конкретному API, например youtube.parameter
.
На этой странице перечислены ошибки, систематизированные по кодам статуса HTTP, определения которых приведены в спецификации RFC 7231.
Вот пример ответа JSON, передающего информацию об ошибке, относящейся к глобальному домену:
{ "error": { "errors": [ { "domain": "global", "reason": "invalidParameter", "message": "Invalid string value: 'asdf'. Allowed values: [mostpopular]", "locationType": "parameter", "location": "chart" } ], "code": 400, "message": "Invalid string value: 'asdf'. Allowed values: [mostpopular]" } }
Ошибки
- MOVED_PERMANENTLY (301)
- SEE_OTHER (303)
- NOT_MODIFIED (304)
- TEMPORARY_REDIRECT (307)
- BAD_REQUEST (400)
- UNAUTHORIZED (401)
- PAYMENT_REQUIRED (402)
- FORBIDDEN (403)
- NOT_FOUND (404)
- METHOD_NOT_ALLOWED (405)
- CONFLICT (409)
- GONE (410)
- PRECONDITION_FAILED (412)
- REQUEST_ENTITY_TOO_LARGE (413)
- REQUESTED_RANGE_NOT_SATISFIABLE (416)
- EXPECTATION_FAILED (417)
- PRECONDITION_REQUIRED (428)
- TOO_MANY_REQUESTS (429)
- INTERNAL_SERVER_ERROR (500)
- NOT_IMPLEMENTED (501)
- SERVICE_UNAVAILABLE (503)
MOVED_PERMANENTLY (301)
Код ошибки | Описание |
---|---|
movedPermanently |
Запрос был отправлен на URL, который больше нельзя использовать. Все запросы для той же операции теперь необходимо отправлять на URL, указанный в заголовке Location полученного ответа. |
SEE_OTHER (303)
Код ошибки | Описание |
---|---|
seeOther |
Запрос успешно обработан. Чтобы получить ответ, отправьте запрос GET на URL, указанный в заголовке Location . |
mediaDownloadRedirect |
Запрос успешно обработан. Чтобы получить ответ, отправьте запрос GET на URL, указанный в заголовке Location . |
NOT_MODIFIED (304)
Код ошибки | Описание |
---|---|
notModified |
Условие, заданное для заголовка If-None-Match, не было выполнено. Этот ответ означает, что запрошенный документ не был изменен и что должен быть получен кешированный ответ. Проверьте значение заголовка If-None-Match в HTTP-запросе. |
TEMPORARY_REDIRECT (307)
Код ошибки | Описание |
---|---|
temporaryRedirect |
Чтобы ваш запрос был обработан, повторно отправьте его на URL, указанный в заголовке Location этого ответа. |
BAD_REQUEST (400)
Код ошибки | Описание |
---|---|
badRequest |
Запрос к API недействителен или неправильно сформирован. Поэтому сервер API не может его распознать. |
badBinaryDomainRequest |
Двоичный запрос к домену недействителен. |
badContent |
Тип данных запроса или тип контента части пакетного запроса не поддерживается. |
badLockedDomainRequest |
Запрос к заблокированному домену недействителен. |
corsRequestWithXOrigin |
Запрос CORS содержит заголовок X-Origin XD3, то есть этот запрос составлен неправильно. |
endpointConstraintMismatch |
Обработать запрос не удалось, так как он не соответствует указанному API. Убедитесь, что вы указали правильный URL. |
invalid |
Обработать запрос не удалось, так как он содержал недопустимое значение. Это может быть значение параметра, заголовка или свойства. |
invalidAltValue |
В значении параметра alt указан неизвестный формат вывода. |
invalidHeader |
Обработать запрос не удалось, так как он содержал недопустимый заголовок. |
invalidParameter |
Обработать запрос не удалось, так как он содержал недопустимый параметр или значение параметра. Чтобы определить, какие параметры можно использовать для запроса, изучите документацию API. |
invalidQuery |
Запрос недействителен. Узнайте, какие параметры можно использовать для запроса, и убедитесь, что запрос не содержит недопустимую комбинацию параметров или недействительные значения параметров. Для этого изучите документацию API. Проверьте значение параметра q . |
keyExpired |
Срок действия ключа API, указанного в запросе, истек. Это означает, что сервер API не может проверить лимит квоты для приложения, отправляющего запрос. Чтобы узнать больше или получить новый ключ, перейдите в Google Developers Console. |
keyInvalid |
Указанный в запросе ключ API недействителен. Это означает, что сервер API не может проверить лимит квоты для приложения, отправляющего запрос. Попробуйте найти ключ с помощью Google Developers Console или получите новый. |
lockedDomainCreationFailure |
Токен OAuth был получен в строке запроса. API запрещает это для всех форматов ответа, кроме JSON и XML. Попробуйте отправить токен OAuth в заголовке Authorization. |
notDownload |
На URL типа /download/* могут быть отправлены только запросы на скачивание мультимедиа. Отправьте запрос на тот же адрес, но без префикса /download . |
notUpload |
На URI с префиксом /upload/* можно отправлять только запросы на загрузку. Ваш запрос не относится к их числу, поэтому обработать его не удалось. Отправьте запрос на тот же адрес, но без префикса /upload . |
parseError |
Сервер API не может обработать тело запроса. |
required |
В запросе отсутствует обязательная информация. Возможно, это параметр или свойство ресурса. |
tooManyParts |
Обработать пакетный запрос не удалось, так как в нем слишком много частей. |
unknownApi |
API, к которому обращается запрос, не распознан. |
unsupportedMediaProtocol |
Медиапротокол клиента не поддерживается. |
unsupportedOutputFormat |
В значении параметра alt указан формат вывода, который не поддерживается этим сервисом. Проверьте значение параметра запроса alt . |
wrongUrlForUpload |
Обработать запрос на загрузку не удалось из-за неправильного URI. Такие запросы можно отправлять только на URI с префиксом /upload/* . Отправьте запрос на тот же адрес, но с префиксом /upload . |
Код ошибки | Описание |
---|---|
unauthorized |
У пользователя нет прав для выполнения этого запроса. |
authError |
Для запроса указаны неправильные учетные данные. Проверьте значение заголовка Authorization в HTTP-запросе. |
expired |
Время сеанса истекло. Проверьте значение заголовка Authorization в HTTP-запросе. |
lockedDomainExpired |
Обработать запрос не удалось, так как истек срок действия заблокированного домена. |
required |
Для выполнения этого запроса к API пользователю необходимо войти в систему. Проверьте значение заголовка Authorization в HTTP-запросе. |
PAYMENT_REQUIRED (402)
Код ошибки | Описание |
---|---|
dailyLimitExceeded402 |
Достигнут дневной лимит бюджета, установленный разработчиком. |
quotaExceeded402 |
Для запрошенной операции необходимо больше ресурсов, чем доступно по квоте. Чтобы выполнить эту операцию, требуется платеж. |
user402 |
Чтобы выполнить запрошенную операцию, требуется платеж от аутентифицированного пользователя. |
FORBIDDEN (403)
Код ошибки | Описание |
---|---|
forbidden |
Запрошенная операция запрещена, и ее нельзя завершить. |
accessNotConfigured |
Для вашего проекта не настроен доступ к этому API. Активируйте API для проекта в Google Developers Console. |
accessNotConfigured |
Проект заблокирован из-за нарушения правил. См. http://support.google.com/code/go/developer_compliance. |
accessNotConfigured |
Проект подлежит удалению. |
accountDeleted |
Аккаунт, связанный с указанными в запросе учетными данными, был удален. Проверьте значение заголовка Authorization в HTTP-запросе. |
accountDisabled |
Аккаунт, связанный с указанными в запросе учетными данными, был отключен. Проверьте значение заголовка Authorization в HTTP-запросе. |
accountUnverified |
Адрес электронной почты пользователя, делающего запрос, не подтвержден. Проверьте значение заголовка Authorization в HTTP-запросе. |
concurrentLimitExceeded |
Обработать запрос не удалось, так как достигнут лимит параллельных соединений. |
dailyLimitExceeded |
Достигнут ежедневный лимит квоты для API. |
dailyLimitExceeded |
Достигнут ежедневный лимит квоты, и проект заблокирован из-за нарушения правил. Подробную информацию можно найти на форуме поддержки по правилам API Google. |
dailyLimitExceededUnreg |
Обработать запрос не удалось, так как достигнут предел анонимного использования API в день. Чтобы продолжить работу с API, войдите в Google Developers Console. |
downloadServiceForbidden |
API не поддерживает скачивание. |
insufficientAudience |
Запрос не может быть выполнен для этой аудитории. |
insufficientAuthorizedParty |
Запрос не может быть выполнен для этого приложения. |
insufficientPermissions |
У аутентифицированного пользователя недостаточно прав для выполнения этого запроса. |
limitExceeded |
Запрос нельзя выполнить из-за ограничений по доступу или частоте. |
lockedDomainForbidden |
API не поддерживает заблокированные домены. |
quotaExceeded |
Для запрошенной операции необходимо больше ресурсов, чем доступно по квоте. |
rateLimitExceeded |
В течение определенного промежутка времени было отправлено слишком много запросов. |
rateLimitExceededUnreg |
Превышен лимит частоты запросов. Чтобы продолжить использование API, зарегистрируйте приложение. Для этого создайте аккаунт, используя Google Developers Console. |
responseTooLarge |
Невозможно получить запрошенный ресурс, так как его размер слишком велик. |
servingLimitExceeded |
Достигнут лимит на частоту запросов для этого API. |
sslRequired |
Эта операция возможна только с применением SSL. |
unknownAuth |
Сервер API не распознает схему авторизации, используемую для запроса. Проверьте значение заголовка Authorization в HTTP-запросе. |
userRateLimitExceeded |
Обработать запрос не удалось, так как частота запросов от этого пользователя превышает допустимую. |
userRateLimitExceededUnreg |
Обработать запрос не удалось, так как достигнут предел частоты запросов от этого пользователя и в запросе не указан разработчик клиента. Создайте проект для вашего приложения в Google Developer Console (https://console.developers.google.com). |
variableTermExpiredDailyExceeded |
Обработать запрос не удалось, так как истек срок действия временной квоты и была исчерпана стандартная дневная. |
variableTermLimitExceeded |
Обработать запрос не удалось, так как была исчерпана временная квота, действующая в указанный период. |
NOT_FOUND (404)
Код ошибки | Описание |
---|---|
notFound |
Не удалось выполнить операцию, так как не найден ресурс, указанный в запросе. |
notFound |
Не найден ресурс, указанный в запросе. Если вы не пользовались этим API в последние две недели, выполните повторное развертывание приложения App Engine и попробуйте вызвать API ещё раз. |
unsupportedProtocol |
Не поддерживается протокол, используемый в запросе. |
METHOD_NOT_ALLOWED (405)
Код ошибки | Описание |
---|---|
httpMethodNotAllowed |
Не поддерживается метод HTTP, связанный с запросом. |
CONFLICT (409)
Код ошибки | Описание |
---|---|
conflict |
Не удалось выполнить запрос к API, так как запрошенная операция может вызвать конфликт с уже существующим объектом. Например, это случается, если запрашивается создание повторяющегося элемента, однако при таких конфликтах, как правило, ошибки диагностируются более конкретно. |
duplicate |
Не удалось выполнить запрошенную операцию, так как она требует создания уже существующего ресурса. |
GONE (410)
Код ошибки | Описание |
---|---|
deleted |
Обработать запрос не удалось, так как указанный в нем ресурс был удален. |
PRECONDITION_FAILED (412)
Код ошибки | Описание |
---|---|
conditionNotMet |
Не было выполнено условие, заданное для заголовка If-Match или If-None-Match в HTTP-запросе. Чтобы узнать больше, прочитайте раздел ETag спецификации HTTP. Проверьте значение заголовка If-Match . |
REQUEST_ENTITY_TOO_LARGE (413)
Код ошибки | Описание |
---|---|
backendRequestTooLarge |
Слишком большой запрос. |
batchSizeTooLarge |
Пакетный запрос содержит слишком много элементов. |
uploadTooLarge |
Обработать запрос не удалось, так как в нем слишком много данных. |
REQUESTED_RANGE_NOT_SATISFIABLE (416)
Код ошибки | Описание |
---|---|
requestedRangeNotSatisfiable |
В запросе указан недопустимый диапазон. |
EXPECTATION_FAILED (417)
Код ошибки | Описание |
---|---|
expectationFailed |
Сервер не может выполнить запрос клиента. |
PRECONDITION_REQUIRED (428)
Код ошибки | Описание |
---|---|
preconditionRequired |
Запрос должен содержать условие. Укажите в запросе заголовки If-Match или If-None-Match , чтобы он был успешно обработан. |
TOO_MANY_REQUESTS (429)
Код ошибки | Описание |
---|---|
rateLimitExceeded |
В течение определенного промежутка времени отправлено слишком много запросов. |
INTERNAL_SERVER_ERROR (500)
Код ошибки | Описание |
---|---|
internalError |
Не удалось обработать запрос из-за внутренней ошибки. |
NOT_IMPLEMENTED (501)
Код ошибки | Описание |
---|---|
notImplemented |
Запрошенная операция не была реализована. |
unsupportedMethod |
Обработать запрос не удалось, так как для этого необходимо выполнить неизвестный метод или операцию. |
SERVICE_UNAVAILABLE (503)
Код ошибки | Описание |
---|---|
backendError |
Произошла ошибка серверного кода. |
backendNotConnected |
Обработать запрос не удалось из-за ошибки подключения. |
notReady |
Сервер API не готов принимать запросы. |
Ошибки, связанные непосредственно с Indexing API
Во всех описанных ниже ситуациях запрос отклоняется, а Googlebot не сканирует соответствующий URL. То же происходит в случае основных ошибок.
BAD_REQUEST (400)
Сообщение об ошибке | Описание |
---|---|
Missing attribute. 'url' attribute is required. |
Пользователь не указал URL в запросе. |
Invalid attribute. 'url' is not in standard URL format |
Пользователь ввел некорректный URL, например «abcd». |
Unknown type. 'type' attribute is required and must be 'URL_REMOVED' or 'URL_UPDATED'. |
Пользователь не указал тип уведомления. |
Invalid value at 'url_notification.type' (TYPE_ENUM) |
Пользователь указал в типе уведомления не URL_REMOVED или URL_UPDATED , а другое значение. |
FORBIDDEN (403)
Сообщение об ошибке | Описание |
---|---|
Permission denied. Failed to verify the URL ownership. |
Пользователь не прошел процедуру подтверждения права собственности или пытается обновить URL, который ему не принадлежит. |
TOO_MANY_REQUESTS (429)
Сообщение об ошибке | Описание |
---|---|
Insufficient tokens for quota 'indexing.googleapis.com/default_requests' |
Пользователь исчерпал свою квоту Indexing API. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons «С указанием авторства 4.0», а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2023-02-22 UTC.