Получение списка загрузок
Возвращает список загруженных RSS-каналов за последний месяц.
Формат запроса
GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/turbo/tasks
? [task_type_filter=<string>]
& [load_status_filter=<string>]
& [offset=<int32>]
& [limit=<int32>]
user-id | Идентификатор пользователя. Значение можно получить с помощью операции GET /v4/user. |
host-id | Идентификатор сайта. Имеет формат scheme:host:port , где
Например: Также идентификатор сайта можно получить с помощью операции GET /user/{user-id}/hosts. |
user-id | Идентификатор пользователя. Значение можно получить с помощью операции GET /v4/user. |
host-id | Идентификатор сайта. Имеет формат scheme:host:port , где
Например: Также идентификатор сайта можно получить с помощью операции GET /user/{user-id}/hosts. |
task_type_filter | Фильтрация по режиму загрузки RSS-канала. Возможные значения:
Например, фильтрация по режиму DEBUG вернет список задач в режиме отладки. |
load_status_filter | Фильтрация по статусу загрузки RSS-канала. Возможные значения:
Например, фильтрация по статусу PROCESSING вернет список задач в статусе обработки. |
offset | Смещение в списке. Минимальное значение — 0. Query-параметр offset можно использовать в паре с параметром limit, например, для создания пагинации. |
limit | Ограничение на количество элементов в списке. Минимальное значение — 1; максимальное значение — 100. Значение по умолчанию — 100. |
task_type_filter | Фильтрация по режиму загрузки RSS-канала. Возможные значения:
Например, фильтрация по режиму DEBUG вернет список задач в режиме отладки. |
load_status_filter | Фильтрация по статусу загрузки RSS-канала. Возможные значения:
Например, фильтрация по статусу PROCESSING вернет список задач в статусе обработки. |
offset | Смещение в списке. Минимальное значение — 0. Query-параметр offset можно использовать в паре с параметром limit, например, для создания пагинации. |
limit | Ограничение на количество элементов в списке. Минимальное значение — 1; максимальное значение — 100. Значение по умолчанию — 100. |
Формат ответа
Сервис возвращает данные в формате JSON (по умолчанию) или XML. Чтобы получить XML-ответ, передайте в запросе HTTP-заголовок Accept: application/xml
.
{
"tasks": [
{
"task_id": "string",
"created_at": "YYYY-MM-DDThh:mm:ss±hh:mm",
"load_status": "string"
},
...
],
"count": 1
}
<Data>
<task>
<task_id>string</task_id>
<created_at>2016-01-01T00:00:00,000+0300</created_at>
<load_status>PROCESSING</load_status>
</task>
<task>
...
</task>
<count>int32</count>
</Data>
task_id
created_at
load_status
- PROCESSING — файл проверяется на ошибки.
- OK — файл загружен и не содержит ошибок.
- WARNING — файл содержит XML-элементы, которые не поддерживаются Яндексом или указаны неправильно.
- ERROR — файл содержит ошибки (например, повторяющиеся XML-элементы).
count
Коды ответа
Код | Описание |
---|---|
200 OK | Запрос выполнен успешно. |
403 Forbidden |
|
404 Not Found |
|
Код | Описание |
---|---|
200 OK | Запрос выполнен успешно. |
403 Forbidden |
|
404 Not Found |
|
Пример
Запрос:
curl -X GET \ 'https://api.webmaster.yandex.net/v3.2/user/12345678/hosts/https:example.com:443/turbo/tasks' \ -H 'Authorization: OAuth oauth_token'
Скопировано
Ответ:
{
"tasks": [
{
"task_id": "49a8f860-ebf7-11e8-b31a-ed044935f842",
"created_at": "2018-11-19T15:33:16.006+03:00",
"load_status": "OK"
}
]
}