Получить состояние импорта
Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.
Запрос позволяет получить информацию о состоянии импорта.
Если импорт остановлен из-за большого количества ошибок, ответ может получиться многостраничным. Чтобы получать ответ постранично, нужно с помощью параметров запроса указать номер страницы и количество почтовых ящиков на каждой из них.
Синтаксис запроса
Запрос следует отправлять по протоколу HTTPS с помощью метода GET.
GET /api2/admin/import/check_imports?
[page=<номер страницы ответа>]
[on_page=<количество почтовых ящиков на каждой странице ответа>]
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...
domain=<имя домена>
Заголовки:
Параметры:
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
Необязательные | ||
page | Число | Номер страницы ответа. Значение по умолчанию — 1. Параметр может понадобиться, если из-за большого количества ошибок ответ может получиться многостраничным. |
on_page | Число | Количество почтовых ящиков с ошибками на каждой странице ответа. Значение по умолчанию — 10. Параметр может понадобиться, если ответ содержит большое количество ошибок. |
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
Необязательные | ||
page | Число | Номер страницы ответа. Значение по умолчанию — 1. Параметр может понадобиться, если из-за большого количества ошибок ответ может получиться многостраничным. |
on_page | Число | Количество почтовых ящиков с ошибками на каждой странице ответа. Значение по умолчанию — 10. Параметр может понадобиться, если ответ содержит большое количество ошибок. |
GET /api2/registrar/import/check_imports?
[page=<номер страницы ответа>]
[on_page=<количество почтовых ящиков на каждой странице ответа>]
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
Authorization: OAuth <OAuth-токен>
...
domain=<имя домена>
Заголовки:
Название | Описание |
---|---|
PddToken | |
Authorization |
Название | Описание |
---|---|
PddToken | |
Authorization |
Параметры:
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
Необязательные | ||
page | Число | Номер страницы ответа. Значение по умолчанию — 1. Параметр может понадобиться, если из-за большого количества ошибок ответ может получиться многостраничным. |
on_page | Число | Количество почтовых ящиков с ошибками на каждой странице ответа. Значение по умолчанию — 10. Параметр может понадобиться, если ответ содержит большое количество ошибок. |
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
domain | Строка | Имя домена. |
Необязательные | ||
page | Число | Номер страницы ответа. Значение по умолчанию — 1. Параметр может понадобиться, если из-за большого количества ошибок ответ может получиться многостраничным. |
on_page | Число | Количество почтовых ящиков с ошибками на каждой странице ответа. Значение по умолчанию — 10. Параметр может понадобиться, если ответ содержит большое количество ошибок. |
Пример запроса
GET /api2/admin/import/check_imports HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/import/check_imports?domain=domain.com'
GET /api2/admin/import/check_imports HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
...
domain=domain.com
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/import/check_imports?domain=domain.com'
Структура ответа
{
"domain": "{имя домена}",
"settings":
{
"method": "{протокол сервера}",
"server": "{имя сервера}",
"port": "{порт сервера}",
"ssl": "{использование SSL}"
},
"import":
{
"state": "{состояние импорта}",
"total_box_count": "{количество отправленных на импорт почтовых ящиков}",
"done_box_count": "{количество успешно импортированных почтовых ящиков}",
"complete_box_count": "{количество успешно импортированных почтовых ящиков и тех, импорт которых завершен с ошибками}",
"failed_boxes_count": "{количество почтовых ящиков, импорт которых остановлен из-за ошибок}",
"failed_boxes_pages": "{количество страниц ответа с информацией о почтовых ящиках, импорт которых был остановлен из-за ошибок}",
"failed_boxes_current_page": "{номер страницы ответа}",
"imported_message_count": "{количество импортированных писем всех почтовых ящиков}",
"total_message_count": "{общее количество отправленных на импорт писем}",
"progress_percent": "{прогресс импорта в процентах}",
"failed_boxes":
[
{
"external_login": "{логин на сервере-источнике}",
"external_password": "{пароль на сервере-источнике}",
"internal_login": "{логин на Яндекс Почте для домена}",
"internal_password": "{пароль на Яндекс Почте для домена}",
"imported_mail": "{количество импортированных писем}",
"last_error": "{код последней ошибки}",
"last_error_count": "{количество ошибок}",
},
...
]
},
"success": "{статус выполнения запроса}"
}
{
"domain": "{имя домена}",
"success": "{статус выполнения запроса}",
"error": "{код ошибки}"
}
Название | Тип значения | Описание |
---|---|---|
domain | Строка | Имя домена. |
settings | Объект | Настройки сервера-источника. |
import | Объект | Информация об импорте. |
success | Строка | Статус выполнения запроса. Возможные значения:
|
error | Строка | Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения:
|
Ключи объекта settings | ||
method | Строка | Протокол сервера. Допустимые значения:
|
server | Строка | Доменное имя или IP-адрес сервера. |
port | Число | Порт сервера. |
ssl | Строка | Использование SSL. Допустимые значения:
|
Ключи объекта import | ||
state | Строка | Состояние импорта. Возможные значения:
|
done_box_count | Число | Количество почтовых ящиков, импорт которых был завершен успешно. |
total_box_count | Число | Количество почтовых ящиков, которые были отправлены на импорт. |
complete_box_count | Число | Количество почтовых ящиков, импорт которых был завершен (успешно или с ошибками). |
failed_boxes_count | Число | Количество почтовых ящиков, импорт которых был остановлен из-за ошибок. |
failed_boxes_pages | Число | Количество страниц ответа с информацией о почтовых ящиках, импорт которых был остановлен из-за ошибок (статус |
failed_boxes_current_page | Число | Номер страницы ответа. |
imported_message_count | Число | Количество импортированных писем всех почтовых ящиков домена (в текущей сессии). |
total_message_count | Число | Общее количество писем почтовых ящиков, которые были отправлены на импорт. |
progress_percent | Число | Прогресс импорта в процентах. |
failed_boxes | Массив | Данные о почтовых ящиках и их ошибках, импорт которых был остановлен (статус |
Ключи объектов массива failed_boxes | ||
external_login | Строка | Логин на сервере-источнике. |
external_password | Строка | Пароль на сервере-источнике. |
internal_login | Строка | Логин для авторизации на Яндекс Почте для домена. |
internal_password | Строка | Пароль для авторизации на Яндекс Почте для домена. |
imported_mail | Число | Количество писем почтового ящика, которые удалось импортировать. |
last_error | Строка | Код ошибки, из-за которой завершилась последняя попытка импорта. |
last_error_count | Число | Количество ошибок, из-за которых импорт был остановлен. |
Название | Тип значения | Описание |
---|---|---|
domain | Строка | Имя домена. |
settings | Объект | Настройки сервера-источника. |
import | Объект | Информация об импорте. |
success | Строка | Статус выполнения запроса. Возможные значения:
|
error | Строка | Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения:
|
Ключи объекта settings | ||
method | Строка | Протокол сервера. Допустимые значения:
|
server | Строка | Доменное имя или IP-адрес сервера. |
port | Число | Порт сервера. |
ssl | Строка | Использование SSL. Допустимые значения:
|
Ключи объекта import | ||
state | Строка | Состояние импорта. Возможные значения:
|
done_box_count | Число | Количество почтовых ящиков, импорт которых был завершен успешно. |
total_box_count | Число | Количество почтовых ящиков, которые были отправлены на импорт. |
complete_box_count | Число | Количество почтовых ящиков, импорт которых был завершен (успешно или с ошибками). |
failed_boxes_count | Число | Количество почтовых ящиков, импорт которых был остановлен из-за ошибок. |
failed_boxes_pages | Число | Количество страниц ответа с информацией о почтовых ящиках, импорт которых был остановлен из-за ошибок (статус |
failed_boxes_current_page | Число | Номер страницы ответа. |
imported_message_count | Число | Количество импортированных писем всех почтовых ящиков домена (в текущей сессии). |
total_message_count | Число | Общее количество писем почтовых ящиков, которые были отправлены на импорт. |
progress_percent | Число | Прогресс импорта в процентах. |
failed_boxes | Массив | Данные о почтовых ящиках и их ошибках, импорт которых был остановлен (статус |
Ключи объектов массива failed_boxes | ||
external_login | Строка | Логин на сервере-источнике. |
external_password | Строка | Пароль на сервере-источнике. |
internal_login | Строка | Логин для авторизации на Яндекс Почте для домена. |
internal_password | Строка | Пароль для авторизации на Яндекс Почте для домена. |
imported_mail | Число | Количество писем почтового ящика, которые удалось импортировать. |
last_error | Строка | Код ошибки, из-за которой завершилась последняя попытка импорта. |
last_error_count | Число | Количество ошибок, из-за которых импорт был остановлен. |