Документация Clouden
Режим фокусировки

Домены верхнего уровня (tld)

Справочник доменов верхнего уровня (tld)

Результат: список элементов.

Домены верхнего уровня.

Уровень доступа: admin.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня.

Выводит список доменов верхнего уровня. Поддерживает фильтрацию и сортировку по параметрам.

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор.
nameСтроканетИмя домена верхнего уровня. Например: ru, com, ac.

Создать или изменить домен верхнего уровня

Функция: tld.edit

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Создать или кнопка Изменить.

Используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidПоложительное целое числонетУникальный идентификатор (элемент id из функции tld).
nameСтрокадаИмя домена верхнего уровня. Например: ru, com, ac.
whois_hostСтроканетДоменное имя WHOIS-сервера для получения информации о домене.
whois_find_stringСтроканетПодстрока, по которой определяется доступность домена в ответе WHOIS. Например: available, not found.
whois_timeoutПоложительное целое числонетТаймаут ожидания ответа от WHOIS-сервера в секундах. Таймаут по умолчанию — 5 секунд.
idn_typeПоложительное целое числонет

Тип поддерживаемых символов доменной зоны:

  • 0 — латинские символы (a–z), арабские цифры (0–9) и дефис;
  • 1 — доменное имя может содержать символы национального алфавита из набора;
  • 2 — доменное имя состоит только из символов национального алфавита из набора.
min_lenghtПоложительное целое числонетМинимальная допустимая длина доменного имени в символах.
max_lenghtПоложительное целое числонетМаксимальная допустимая длина доменного имени после преобразования в Punycode.
info_sourceПоложительное целое числонет

Источник информации о домене. Возможные значения:

  • 0 — WHOIS;
  • 1 — RDAP.
rdap_urlСтроканетURL RDAP-сервера (Registration Data Access Protocol) для получения информации о домене.
embeddedФлагнетПризнак встроенного домена верхнего уровня. Значение по умолчанию: on.
sokСтрокадаЗначение ok подтверждает выполнение операции. Без этого параметра изменения не будут применены.

Удалить домен верхнего уровня

Функция: tld.delete

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Удалить.

Удаляет домен. Поддерживает удаление нескольких доменов верхнего уровня.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько уникальных идентификаторов объекта, разделённых запятыми. Уникальный идентификатор — элемент id из функции tld.

Таблицы символов

Отобразить список таблиц символов

Функция: tld.idntable

Результат: список элементов.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Символы.

Возвращает таблицы символов, разрешённых к использованию в доменных именах. Доступна только для доменов с поддержкой символов из наборов.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
nameСтроканетНаименование таблицы символов.
statusСтроканетСостояние таблицы символов.

Отобразить содержимое таблицы символов

Функция: tld.idntable.view

Результат: список параметров объекта.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Символы → кнопка Просмотреть.

Возвращает содержимое выбранной таблицы символов.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор родительского списка (элемент id из функции tld).
elidСтрокадаУникальный идентификатор (элемент key из функции tld.idntable).

Включить таблицу

Функция: tld.idntable.resume

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Символы → кнопка Включить.

Разрешает использование выбранной таблицы символов в доменных именах.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько уникальных идентификаторов объекта, разделённых запятыми. Уникальный идентификатор — элемент key из функции tld.idntable.

Выключить таблицу

Функция: tld.idntable.suspend

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Символы → кнопка Выключить.

Запрещает использование выбранной таблицы символов в доменных именах.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько уникальных идентификаторов объекта, разделённых запятыми. Уникальный идентификатор — элемент key из функции tld.idntable.

Обновить данные RDAP

Функция: tld.rdap.update

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Обновить RDAP.

Заполняет поля rdap_url для доменов верхнего уровня на основе официальных данных IANA из источника https://data.iana.org/rdap/dns.json.

Уровень доступа: admin.

Настроить параметры контакта домена

Функция: tld.service_profileparam

Результат: список элементов.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов.

Возвращает список параметров контактов для доменов верхнего уровня. Все параметры фильтрации необязательны.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор параметра.
nameСтроканетНаименование параметра для отображения в интерфейсе.
intnameСтроканетВнутреннее имя параметра (наименование для сотрудников).
hintСтроканетПодсказка к полю, отображаемая при наведении.
countryСтрока (список)нетСтраны, для которых параметр актуален. Значение Все означает применение для всех стран.
profiletypeСтрока (перечисление)нет

Тип контакта. Допустимые значения:

  • 1 — физическое лицо;
  • 2 — юридическое лицо;
  • 3 — индивидуальный предприниматель.
contacttypeСтрока (перечисление)нет

Вид контакта. Допустимые значения:

  • 1 — контакт клиента;
  • 2 — контакт владельца;
  • 3 — финансовый контакт;
  • 4 — административный контакт;
  • 5 — технический контакт;
  • 6 — CED (вариант для доменной зоны .asia).
processingmoduleСтрока (список)нетОбработчики регистраторов, подключённые к параметру.
requiredФлагнетПризнак обязательности заполнения параметра.
activeФлагнетПризнак активности параметра.
baseparamФлагнетПризнак параметра по умолчанию (нельзя отключить или удалить).
orderpriorityПоложительное целое числонетПриоритет параметра при сортировке списка (по возрастанию).

Создать параметр контакта

Функция: tld.service_profileparam.add

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Создать.

Создаёт новый параметр контакта домена с привязкой к обработчикам.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор доменной зоны (элемент id из функции tld).
processingmoduleСтрока (список)даСписок ID обработчиков регистраторов через запятую, к которым подключается параметр.
nameСтроканетНаименование параметра для отображения в интерфейсе.
intnameСтрокадаВнутреннее имя параметра. Латиница, без пробелов, не начинается с цифры.
hintСтроканетПодсказка к полю, отображаемая при наведении.
countryСтрока (список)даСписок стран, для которых параметр актуален.
profiletypeСтрока (список)да

Тип контакта. Допустимые значения:

  • 1 — физическое лицо;
  • 2 — юридическое лицо;
  • 3 — индивидуальный предприниматель.
contacttypeСтрока (список)да

Вид контакта. Допустимые значения:

  • 1 — контакт клиента;
  • 2 — контакт владельца;
  • 3 — финансовый контакт;
  • 4 — административный контакт;
  • 5 — технический контакт;
  • 6 — CED (вариант для доменной зоны .asia).
inputtypeПоложительное целое числонет

Тип поля ввода

  • 0 — строковое;
  • 1 — список;
  • 2 — множественный;
  • 3 — флаг;
  • 4 — текстовое.
validatorСтрока (перечисление)нетФункция проверки значения: email, phone, int, latin, date и др.
orderpriorityПоложительное целое числонетПриоритет параметра при сортировке (по возрастанию).
sokСтрокадаЗначение ok подтверждает выполнение операции.

Редактировать параметр контакта

Функция: tld.service_profileparam.edit

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → выберите параметр → кнопка Изменить.

Позволяет изменить параметр контакта домена.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаУникальный идентификатор редактируемого параметра (элемент id из функции tld.service_profileparam).
nameСтроканетНаименование параметра для отображения в интерфейсе.
intnameСтроканетВнутреннее имя параметра.
hintСтроканетПодсказка к полю.
countryСтрока (список)нетСписок стран, для которых параметр актуален.
profiletypeСтрока (список)нет

Тип контакта. Допустимые значения:

  • 1 — физическое лицо;
  • 2 — юридическое лицо;
  • 3 — индивидуальный предприниматель.
contacttypeСтрока (список)нет

Вид контакта. Допустимые значения:

  • 1 — контакт клиента;
  • 2 — контакт владельца;
  • 3 — финансовый контакт;
  • 4 — административный контакт;
  • 5 — технический контакт;
  • 6 — CED (вариант для доменной зоны .asia).
inputtypeПоложительное целое числонет

Тип поля ввода

  • 0 — строковое;
  • 1 — список;
  • 2 — множественный;
  • 3 — флаг;
  • 4 — текстовое.
validatorСтрока (перечисление)нетФункция проверки значения.
orderpriorityПоложительное целое числонетПриоритет параметра при сортировке.
minlength_NПоложительное целое числонетМинимальная длина для обработчика, где N — id обработчика.
maxlength_NПоложительное целое числонетМаксимальная длина для обработчика, где N — id обработчика.
required_NФлагнетОбязательность для обработчика, где N — id обработчика.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Настроить обработчик для параметра

Функция: tld.service_profileparam.processingmodule.edit

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Обработчики → выберите обработчик → кнопка Изменить.

Настройка обязательности и ограничений длины для параметра в конкретном обработчике регистратора.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаУникальный идентификатор настройки обработчика.
requiredФлагнетСделать параметр обязательным для данного обработчика.
minlengthПоложительное целое числонетМинимальное число символов для текстового поля.
maxlengthПоложительное целое числонетМаксимальное число символов для текстового поля.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Список обработчиков параметра

Функция: tld.service_profileparam.processingmodule

Результат: список элементов.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Обработчики.

Возвращает список обработчиков регистраторов, подключённых к параметру.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор подключения.
nameСтроканетНаименование обработчика.
activeФлагнетПризнак активности подключения.
orderpriorityПоложительное целое числонетПриоритет обработчика при сортировке.

Включить обработчик параметра

Функция: tld.service_profileparam.processingmodule.resume

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Обработчики → кнопка Вкл.

Активирует подключение параметра к обработчику. Поддерживает групповую операцию.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id подключений через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить обработчик параметра

Функция: tld.service_profileparam.processingmodule.suspend

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Обработчики → кнопка Выкл.

Деактивирует подключение параметра к обработчику. Поддерживает групповую операцию.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id подключений через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Настроить значения для параметров типа "Список"

Функция: tld.service_profileparam.value

Результат: список элементов.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Значения.

Возвращает список допустимых значений для параметров с типом "Список".

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
idПоложительное целое числонетУникальный идентификатор значения.
nameСтроканетНаименование значения для отображения.
intnameСтроканетВнутреннее имя значения для передачи в обработчик.
orderpriorityПоложительное целое числонетПриоритет значения при сортировке (по возрастанию).

Создать или изменить значение списка

Функция: tld.service_profileparam.value.edit

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Значения → кнопка Создать или Изменить.

Позволяет просмотреть, изменить или создать значение для параметра типа "Список".

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор родительского параметра (элемент id из функции tld.service_profileparam).
elidПоложительное целое числонетУникальный идентификатор редактируемого значения (элемент id из функции tld.service_profileparam.value).
nameСтрокадаНаименование значения для отображения.
intnameСтрокадаВнутреннее имя значения. Латиница, без пробелов, не начинается с цифры.
codeСтроканетКод значения для передачи в обработчик.
orderpriorityПоложительное целое числонетПриоритет значения при сортировке (по возрастанию).
sokСтрокадаЗначение ok подтверждает выполнение операции.

Удалить значение списка

Функция: tld.service_profileparam.value.delete

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Значения → кнопка Удалить.

Поддерживает удаление нескольких значений через запятую.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id значений через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Переместить значение списка вверх

Функция: tld.service_profileparam.value.up

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Значения → кнопка Вверх.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid значения для перемещения.

Переместить значение списка вниз

Функция: tld.service_profileparam.value.down

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Значения → кнопка Вниз.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid значения для перемещения.

Включить параметр

Функция: tld.service_profileparam.resume

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Вкл.

Активирует параметр контакта домена. Поддерживает групповую операцию.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id параметров через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Выключить параметр

Функция: tld.service_profileparam.suspend

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Выкл.

Деактивирует параметр контакта домена. Поддерживает групповую операцию.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidСтрока (список)даОдин или несколько id параметров через запятую.
sokСтрокадаЗначение ok подтверждает выполнение операции.

Восстановить параметры по умолчанию

Функция: tld.service_profileparam.restoredefault

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Восстановить.

Восстанавливает список параметров контакта домена к значениям по умолчанию для указанной доменной зоны.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
plidПоложительное целое числодаУникальный идентификатор доменной зоны (элемент id из функции tld).
sokСтрокадаЗначение ok подтверждает выполнение операции.

Переместить параметр вверх

Функция: tld.service_profileparam.up

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Вверх.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid параметра для перемещения.

Переместить параметр вниз

Функция: tld.service_profileparam.down

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Вниз.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
elidПоложительное целое числодаid параметра для перемещения.

Установить фильтр

Функция: tld.service_profileparam.filter

Результат: успешное выполнение операции или сообщение об ошибке.

В веб-интерфейсе платформы: раздел СправочникиДомены верхнего уровня → кнопка Параметры контактов → кнопка Фильтр.

Сохраняет условия отбора, которые применяются при каждом отображении списка параметров до изменения или снятия.

Уровень доступа: admin.

ПараметрТипОбязательныйЗначение
nameСтроканетПоиск по наименованию параметра. Поддерживается подстановочный знак *.
intnameСтроканетПоиск по внутреннему имени параметра.
statusФлагнет

Фильтр по состоянию. Возможные значения:

  • on — активен;
  • off — отключён.
countryСтрока (список)нетФильтр по стране.
profiletypeСтрока (список)нетФильтр по типу контакта.
contacttypeСтрока (список)нетФильтр по виду контакта.
resetФлагнетЗначение on сбрасывает все установленные фильтры.
sokСтрокадаЗначение ok подтверждает сохранение фильтра.