Обзор
Этот интерфейс позволяет интерактивно запускать функции cPanel API.
Важно:
- Этот интерфейс доступен только для аккаунтов-реселлеров.
- В интерфейсе API Shell доступны только функции cPanel API 2 и UAPI.
Внимание:
Эта функция использует живые данные с вашего сервера. Вызовы функций API могут изменить или удалять данные на вашем сервере, что может привести к сбою сервера.
- Тщательно прочитайте документацию по функции, прежде чем использовать её в интерфейсе API Shell.
- Чтобы увидеть пример вывода этой функции, ознакомьтесь с разделом «Примеры откликов» функции в нашей документации cPanel Developer.
Включите интерфейс API Shell
Чтобы использовать эту функцию, ваш хостинг-провайдер должен включить её для вас. Попросите их выполнить следующие шаги в WHM:
- Выберите «Включено» для настройки cPanel и WHM API (для разработчиков) во вкладке System интерфейса Tweak Settings WHM (WHM » Главная » Настройка сервера » Tweak Settings).
- Уведите функцию API Shell в список функций вашего аккаунта в интерфейсе Feature Manager WHM (WHM » Главная » Пакеты » Feature Manager).
Вызов функции API
Чтобы вызвать функцию API, выполните следующие шаги:
- Выберите вариант UAPI (API 3) или API 2 в разделе версии cPanel API.
- Выберите функцию API из меню выбранной версии API.
- В разделе «Переменные» введите ключи и значения функции API в текстовые поля. Если в функции API есть необходимые пары ключей и значения, вы должны их ввести.
- Чтобы добавить новую запись переменной, нажмите Добавить.
- Чтобы удалить запись переменной, нажмите на значок X.
- Чтобы отфильтровать, отсортировать или поместить на страницы результаты, нажмите Показать варианты сортировки/фильтрации/Страницы:
- Чтобы выбрать первую запись из результатов, введите число в Индекс первых результатов для отображения, текстовое поле с нулём или используйте меню для выбора номера.
- Значение показывает неограниченное количество результатов.
0
- Значение показывает неограниченное количество результатов.
- Чтобы ограничить количество результатов для отображения, введите число в Maximum # of results для отображения текстового поля или используйте меню для выбора номера.
- Значение показывает неограниченное количество результатов.
0
- Значение показывает неограниченное количество результатов.
- Чтобы отфильтровать результаты, нажмите «Добавить» в разделе «Фильтры» интерфейса. Вы можете указать поле для фильтрации результатов, условия (Contains, Starting S, Equals, Greater Than (числовое) или Меньше (числовое)) и термин для применения к этим условиям.
- Чтобы добавить новый фильтр, нажмите Добавить.
- Чтобы убрать фильтр, нажмите на значок X.
- Чтобы отсортировать результаты, нажмите «Добавить» в разделе «Сортировка» интерфейса. Вы можете указать поле, по которому хотите сортировать результаты, условия (лексикографические, числовые, numeric_zero_as_max или ipv4) и следует ли менять порядок сортировки.
- Чтобы добавить новый метод сортировки, нажмите Добавить.
- Чтобы убрать порядок сортировки, нажмите на значок X.
- Чтобы ограничить отображение столбцов, нажмите «Добавить» в разделе «Столбцы» интерфейса. Затем введите номер столбца в текстовое поле столбца.
- Чтобы добавить больше столбцов для отображения, нажмите Добавить.
- Чтобы удалить столбец, нажмите на значок X.
- Чтобы выбрать первую запись из результатов, введите число в Индекс первых результатов для отображения, текстовое поле с нулём или используйте меню для выбора номера.
- Нажмите «Отправить».
При изменении значений функции API интерфейс обновляет записи разделов данных URL и структуры вызовов API.
Ответ на вызовы API
После нажатия «Отправить» возвраты функции API появляются в разделе ответа на вызов API интерфейса. Результаты можно посмотреть в вкладках Tree view, Table и Raw.
Примечание:
- Вкладка Raw view отделяет ответ API-вызова от HTTP-заголовков.
- Представление таблицы может быть недоступно для определённых данных функций.
