Проверка статуса задачи на переобход

Вовзращает статус задачи на переобход страницы сайта.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

Формат запроса

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/recrawl/queue/{task-id}

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.

Query-параметры

Имя Обязательный Тип Значение по умолчанию Описание
task-id Да UUID ID задачи на переобход. Чтобы получить идентификатор, используйте метод GET /user/{user-id}/hosts/{host-id}/recrawl/queue/.

Формат ответа

Примеры

{
  "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a",
  "url": "http://example.com/some/path?a=b",
  "added_time": "2016-01-01T00:00:00,000+0300",
  "state": "IN_PROGRESS"
}
Имя Обязательный Тип Описание
task_id Да string ID задачи на переобход.
url Да string URL страницы, отправленной на переобход.
added_time Нет datetime Дата создания заявки на переобход.
state Да RecrawlStatusEnum Статус завяки на переобход.

Статусы заявки на переобход (RecrawlStatusEnum)

Индикатор Описание
IN_PROGRESS Заявка обрабатывается.
DONE Робот обошел URL
FAILED Робот не смог обойти страницу. Проверьте, что она доступна для робота и сервер отвечает достаточно быстро.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код Причина Описание
200 OK
403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
TASK_NOT_FOUND
Не найдена задача с указанным ID.
{
  "error_code": "TASK_NOT_FOUND",
  "error_message": "some string"
}