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

Отправляет URL на переобход.

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

В теле запроса передайте URL страницы, которую нужно переобойти.

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

user-id

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

host-id

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

Пример

{
  "url": "http://example.com"
}
<Data>
    <url>http://example.com</url>
</Data>

Параметр

Описание

url

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

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

Примеры

{
  "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a",
  "quota_remainder": 1
}
<Data>
  <task_id>c7fe80c0-36e3-11e6-8b2d-df96aa592c0a</task_id>
  <quota_remainder>1</quota_remainder>
</Data>

Имя

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

Тип

Описание

task_id

Да

UUID

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

quota_remainder

Да

int32

Остаток суточной квоты.

Коды ответа

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

Код

Причина

Описание

202

ACCEPTED

400

INVALID_URL

Передан неправильный URL.

{
  "error_code": "INVALID_URL",
  "error_message": "some string"
}
<Data>
  <error_code>INVALID_URL</error_code>  
  <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>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

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

{
  "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>

409

URL_ALREADY_ADDED

URL уже добавлен в переобход.

{
  "error_code": "URL_ALREADY_ADDED",
  "error_message": "some string"
}
<Data>
  <error_code>URL_ALREADY_ADDED</error_code>  
  <error_message>some string</error_message>
</Data>

429

QUOTA_EXCEEDED

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

{
  "error_code": "QUOTA_EXCEEDED",
  "daily_quota": 1,
  "exceeded_until": "2016-01-01T00:00:00,000+0300",
  "error_message": "some string"
}
<Data>
  <error_code>QUOTA_EXCEEDED</error_code>  
  <daily_quota>1</daily_quota>  
  <exceeded_until>2016-01-01T00:00:00,000+0300</exceeded_until>  
  <error_message>some string</error_message>
</Data>

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