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

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

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/recrawl/queue
  ? [offset=<int32>]
  & [limit=<int32>]
  & [date_from=<datetime>]
  & [date_to=<datetime>]

`user-id`	Тип: `int64`. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
`host-id`	Тип: `host id (string)`. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.
`offset`	Смещение в списке. Значение по умолчанию: 0.
`limit`	Количество записей. Минимальное значение — 1. Значение по умолчанию: 50.
`date_from`	Начало диапазона дат.
`date_to`	Конец диапазона дат.

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

Примеры

JSON

XML
{
  "tasks": [
    {
      "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"
    }
  ]
}
<Data>
  <task>
    <task_id>c7fe80c0-36e3-11e6-8b2d-df96aa592c0a</task_id>
    <url>http://example.com/some/path?a=b</url>
    <added_time>2016-01-01T00:00:00,000+0300</added_time>
    <state>IN_PROGRESS</state>
  </task>
</Data>
Имя

Обязательный

Тип

Описание

task_id

Да

string

ID задачи на переобход.

url

Да

string

URL страницы, отправленной на переобход.

added_time

Нет

datetime

Дата создания заявки на переобход.

state

Да

string (RecrawlStatusEnum)

Статус завяки на переобход.

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

Коды ответа

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

Код	Причина	Описание
200	OK
403	INVALID_USER_ID	ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже `{user_id}` указан правильный `uid` владельца OAuth-токена. JSON XML `{ "error_code": "INVALID_USER_ID", "available_user_id": 1, "error_message": "Invalid user id. {user_id} should be used." }` `<Data> <error_code>INVALID_USER_ID</error_code> <available_user_id>1</available_user_id> <error_message>Invalid user id. {user_id} should be used.</error_message> </Data>`
404	HOST_NOT_VERIFIED	Не подтверждены права на управление сайтом. JSON XML `{ "error_code": "HOST_NOT_VERIFIED", "host_id": "http:ya.ru:80", "error_message": "some string" }` `<Data> <error_code>HOST_NOT_VERIFIED</error_code> <host_id>http:ya.ru:80</host_id> <error_message>some string</error_message> </Data>`

Узнайте больше

Коды ошибок и статусы

Была ли статья полезна?

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

Проверка квоты на переобход

Имя	Обязательный	Тип	Описание
`task_id`	Да	`string`	ID задачи на переобход.
`url`	Да	`string`	URL страницы, отправленной на переобход.
`added_time`	Нет	`datetime`	Дата создания заявки на переобход.
`state`	Да	`string` (RecrawlStatusEnum)	Статус завяки на переобход.