Получение списка загрузок

Описание

Возвращает список созданных задач на добавление RSS-каналов за последний месяц.

Ответ API может приходить в формате JSON или XML. По умолчанию возвращается JSON. Чтобы получить XML-ответ, передайте в запросе заголовок Accept: application/xml.

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

Отправьте GET-запрос на адрес ресурса turbo/tasks, указав параметры предпочитаемого отображения списка.

GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/turbo/tasks/[?task_type_filter={task_type_filter}&offset={offset}&limit={limit}]
Пример с использованием утилиты Curl
curl 'https://api.webmaster.yandex.net/v3.2/user/1234567/hosts/http:example.com:80/turbo/tasks/?offset=10&mode=DEBUG' -H 'Authorization: OAuth AQAAAAA'

Path-параметры

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

Query-параметры

Имя Обязательный Тип Значение по умолчанию Описание
task_type_filter Нет TaskTypeFilter ALL Фильтрация по режиму загрузки Турбо-страниц.
load_status_filter Нет LoadStatus Фильтрация по статусу задачи на добавление RSS-канала.
offset Нет int32 0 Смещение в списке. Минимальное значение — 0.
limit Нет int32 100 Ограничение на количество элементов в списке. Минимальное значение — 1; максимальное значение — 100.

Фильтр режима загрузки RSS-канала (TaskTypeFilter)

Индикатор Описание
DEBUG Отладка отображения Турбо-страниц.
PRODUCTION Публикация Турбо-страниц.
ALL Получение информации о задачах обоих типов.

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

В случае успеха сервер возвращает 200 и список идентификаторов созданных ранее задач на добавление RSS-каналов.

Примеры

{
  "tasks": [
    {
      "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a",
      "created_at": "2016-01-01T00:00:00,000+0300",
      "load_status": "PROCESSING"
    }
  ],
  "count": 1
}
Имя Обязательный Тип Описание
task_id Да UUID Идентификатор задачи на добавление RSS-канала в Яндекс.Вебмастер.
created_at Да dateTime Дата и время создания задачи на добавление RSS-канала.
load_status Да LoadStatus Статус загрузки задачи на добавление RSS-канала.
count Да int32 Количество идентификаторов.

Вы можете управлять форматом ответа API.

Статусы загрузки задачи на добавление RSS-канала (LoadStatus)

Индикатор Описание
PROCESSING Файл проверяется на ошибки.
OK Файл загружен и не содержит ошибок.
WARNING Файл содержит XML-элементы, которые не поддерживаются Яндексом или указаны неправильно.
ERROR Файл содержит ошибки (например, повторяющиеся XML-элементы).

Ошибки

403 Forbidden

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

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Параметр Описание
error_code Код ошибки.
available_user_id ID пользователя, от имени которого разрешен доступ.
error_message Сообщение об ошибке.

404 Not Found

  • Код ошибки HOST_NOT_INDEXED

    {
      "error_code": "HOST_NOT_INDEXED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Параметр Описание
    error_code Сайт еще не проиндексирован.
    host_id ID запрошенного сайта.
    error_message Сообщение об ошибке.
  • Код ошибки HOST_NOT_LOADED

    {
      "error_code": "HOST_NOT_LOADED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Параметр Описание
    error_code Данные о сайте еще не загружены в Яндекс.Вебмастер.
    host_id ID запрошенного сайта.
    error_message Сообщение об ошибке.
  • Код ошибки HOST_NOT_VERIFIED

    {
      "error_code": "HOST_NOT_VERIFIED",
      "host_id": "http:ya.ru:80",
      "error_message": "explicit error message"
    }
    Параметр Описание
    error_code Сайт не добавлен в список сайтов или права не подтверждены пользователем.
    host_id ID запрошенного сайта.
    error_message Сообщение об ошибке.