Получение статуса асинхронной загрузки фида

Возвращает статус добавленного для загрузки YML-фида с помощью метода POST /v4/user/{user_id}/hosts/{host_id}/feeds/add/start/.

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/feeds/add/info

user-id

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

host-id

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

Пример

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

<Data>
    <requestId>c7fe80c0-36e3-11e6-8b2d-df96aa592c0a</requestId>
</Data>

Имя

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

Тип

Описание

requestId

Да

UUID

Идентификатор загрузки. Чтобы получить его, используйте метод POST /v4/user/{user_id}/hosts/{host_id}/feeds/add/start/.

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

Примеры

{
  "processStatus": "OK"
}

<Data>
    <processStatus>OK</processStatus>
</Data>

Имя

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

Тип

Описание

processStatus

Да

string

Статус загрузки YML-фида. Возможные значения:

  • OK — загрузка завершена;
  • IN_PROGRESS — фид загружается.

Коды ответа

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

Код

Причина

Описание

200

OK

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

BAD_HTTP_CODE

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

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

404

BAD_MIME_TYPE

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

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

404

REQUEST_NOT_FOUND

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

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

404

TIMED_OUT

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

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

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

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

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

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

Да

Тип

UUID

Описание

Идентификатор загрузки. Чтобы получить его, используйте метод POST /v4/user/{user_id}/hosts/{host_id}/feeds/add/start/.

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

Да

Тип

string

Описание

Статус загрузки YML-фида. Возможные значения:

  • OK — загрузка завершена;
  • IN_PROGRESS — фид загружается.
Предыдущая
Асинхронная загрузка фида
Следующая
Загрузка нескольких фидов