Выгрузка архива всех страниц сайта

Возвращает архив c информацией о страницах, которые были добавлены в Sitemap.

Скачать архив можно в Вебмастере на странице Индексирование → Все страницы.
Чтобы скачать архив:

  1. С помощью POST-запроса начните формирование архива.
    В зависимости от размера архива процесс может занять от 10 секунд до 3 минут. В результате вы получите task_id— уникальный идентификатор задачи по формированию архива.

  2. C помощью GET-запроса проверьте статус задачи.

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

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/indexing/archive/

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

Тип: string. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

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

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

Тип: string. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

task-id

Тип: UUID. ID задачи на формирование архива.

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

JSON

{
    "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a"
}

Параметр

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

Тип

Описание

task_id

Да

string

Идентификатор задачи формирования архива.

JSON

{
    "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a",
    "state": "DONE",
    "download_url": "https://storage.mds.yandex.net/..."
}

Параметр

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

Тип

Описание

task_id

Да

string

Идентификатор задачи формирования архива.

state

Да

string

Cтатус задачи. Возможные значения:

  • IN_PROGRESS — архив формируется. Периодически отправляйте GET-запросы, чтобы следить за выполнением задачи.
  • DONE — архив сформирован. В поле download_url появится ссылка для скачивания.
  • FAILED — задача не выполнена по какой-либо причине.

download_url

Да

string

URL-адрес для скачивания архива, если задача имеет статус DONE.

Коды ответа

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

Код

Причина

Описание

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."
}

<Data>
    <[error_code](*error_code)>INVALID_USER_ID</error_code>
    <[available_user_id](*available_user_id)>1</available_user_id>
    <[error_message](*error_message)>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_VERIFIED

Не подтверждены права на управление сайтом.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}

<Data>
  <[error_code](*error_code)>HOST_NOT_VERIFIED</error_code>  
  <[host_id](*host_id)>http:ya.ru:80</host_id>
  <[error_message](*error_message)>some string</error_message>
</Data>

Код

Причина

Описание

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."
}

<Data>
    <[error_code](*error_code)>INVALID_USER_ID</error_code>
    <[available_user_id](*available_user_id)>1</available_user_id>
    <[error_message](*error_message)>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_VERIFIED

Не подтверждены права на управление сайтом.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}

<Data>
  <[error_code](*error_code)>HOST_NOT_VERIFIED</error_code>  
  <[host_id](*host_id)>http:ya.ru:80</host_id>
  <[error_message](*error_message)>some string</error_message>
</Data>

404

TASK_NOT_FOUND

Не найдена задача с указанным ID.

{
  "error_code": "TASK_NOT_FOUND",
  "error_message": "some string"
}

<Data>
  <[error_code](*error_code)>TASK_NOT_FOUND</error_code>  
  <[error_message](*error_message)>some string</error_message>
</Data>

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

Предыдущая
Получение истории изменений важной страницы
Следующая
Получение истории изменения количества страниц в поиске