Получение списка сайтов пользователя
Возвращает список сайтов, добавленных пользователем, и сводную информацию о каждом из них.
Формат запроса
GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts
|
Тип: |
Формат ответа
Пример
{
"hosts": [
{
"host_id": "http:ya.ru:80",
"ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
"unicode_host_url": "http://Яндекс рф/",
"verified": true,
"main_mirror": {
"host_id": "http:ya.ru:80",
"verified": true,
"ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
"unicode_host_url": "http://Яндекс рф/"
}
}, ...
]
}
<Data>
<host>
<host_id>http:ya.ru:80</host_id>
<ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
<unicode_host_url>http://Яндекс рф/</unicode_host_url>
<verified>yes</verified>
<main_mirror>
<host_id>http:ya.ru:80</host_id>
<verified>false</verified>
<ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
<unicode_host_url>http://Яндекс рф/</unicode_host_url>
</main_mirror>
</host>
...
</Data>
Имя |
Обязательный |
Тип |
Описание |
|
Да |
|
ID сайта. |
|
Да |
|
ASCII URL сайта. |
|
Нет |
|
UTF-8 URL сайта. |
|
Да |
|
Подтвержден ли сайт. |
|
Да |
Главный адрес сайта, если есть. |
Статус |
Описание |
|
Проверка не проводилась, права не подтверждены. |
|
Права подтверждены. |
|
Идет подтверждение прав. |
|
Проверка проводилась, права не подтверждены. |
|
В процессе проверки прав произошла непредвиденная ошибка. |
Причина отказа |
Описание |
|
Делегирование прав отменено. |
|
Отсутствует указанная DNS-запись. |
|
Отсутствует метатег в заголовке главной страницы сайта. |
|
Содержимое HTML-файла задано неверно. |
Коды ответа
Чтобы посмотреть структуру ответа подробнее, нажмите на причину.
Код |
Причина |
Описание |
200 |
OK |
|
403 |
ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже JSON
XML
|
Узнайте больше
Тип: int64
. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
Тип: host id (string)
. ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.
Обязательный параметр
Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.
Количество записей (1-100). Значение по умолчанию: 10.
Описание
Код ошибки.
Описание
Сообщение об ошибке.
Описание
Значение.
Описание
Поле.
Описание
ID запрошенного сайта.
Описание
ID сайта.
Описание
Признак подтверждения сайта.
Описание
ID файла Sitemap
.
Описание
Список поддерживаемых типов контента.
Описание
Лимит на количество добавленных сайтов.
Описание
Лимит количества фидов.
Описание
Лимит количества добавленных фидов.
Описание
ID пользователя, от имени которого разрешен доступ.
Описание
Дата и время, до которого адрес доступен для создания задачи.
Описание
Список поддерживаемых типов контента.
Описание
Список поддерживаемых типов кодировки.
Описание
Максимальная длина.
Описание
Минимальная длина.
Описание
Доступное количество запросов в сутки.
Обязательный
Да
Тип
host id
(string
)
Описание
ID сайта.
Обязательный
Да
Тип
string
Описание
ASCII URL сайта.
Обязательный
Нет
Тип
string
Описание
UTF-8 URL сайта.
Обязательный
Да
Тип
boolean
Описание
Подтвержден ли сайт.
Обязательный
Да
Тип
Описание
Главный адрес сайта, если есть.