Документация BILLmanager 6
Документация
/
Документация BILLmanager 6
/
Разработчику
/
BILLmanager API
/
Виртуальный ДЦ (vdc)

Виртуальный ДЦ (vdc)

vdc

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

Виртуальный дата-центр

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

ПараметрЗначение
vdcname Наименование
idId
pricelist Тариф
account Клиент
projectПровайдер
datacentername Дата-центр
processingmodule Модуль обработки
createdate Дата создания
expiredate Действует до
autoprolong Автопродление
status_msg 
item_status статус услуги. Может принимать значения: 
  • 1 — заказана; 
  • 2 — активна; 
  • 3 — остановлена;
  • 4 — удалена; 
  • 5 — обрабатывается; 
cost Стоимость

Networks

Функция: vdc.network

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

Сети

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

ПараметрЗначение
idId
name Наименование
vm_group
router Маршрутизатор
gateway Шлюз
mask Маска сети
network_subnets Адреса подсетей
network_pools Пул IP-адресов
statusСостояние

Подсети

Функция: vdc.network.subnet

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

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

ПараметрЗначение
idId
name Наименование
cidr Адрес подсети
gateway Адрес шлюза
status Состояние

Удалить

Функция: vdc.network.subnet.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.network.subnet.

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

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

Функция: vdc.network.subnet.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.network).
    • elid — уникальный идентификатор (элемент id из функции vdc.network.subnet)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.network).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.network).
    • elid — уникальный идентификатор (элемент id из функции vdc.network.subnet)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование
subnet_type Тип выбора сетевого адреса
pool Пул. Выберите сетевой адрес из пула
mask Маска подсети
cidr Адрес подсети
use_gateway Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Использовать шлюз для данной подсети. Под шлюз будет занят один из адресов подсети
gateway Адрес шлюза используемый в подсети. Для назначения адреса автоматически, необходимо оставить пустым
use_dhcp Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Использовать DHCP для данной подсети. Под DHCP будет занят один из адресов подсети

Удалить

Функция: vdc.network.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.network.

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

Редактирование сети

Функция: vdc.network.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.network)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.network)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование
vdc_vm_group Группа виртуальных серверов. Позволяет создать сеть доступную только внутри группы виртуальных серверов
create_subnet Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Включает возможность создать подсеть вместе одновременно с сетью
subnet_name Наименование подсети
subnet_type Тип выбора сетевого адреса
subnet_pool Пул. Выберите сетевой адрес из пула
subnet_mask Маска подсети
subnet_cidr Адрес подсети в виде 'адрес_сети/маска_сети'. Например 192.168.0.0/24
subnet_use_gatewayНеобязательный параметр. Чтобы включить данную опцию используйте значение "on". Использовать шлюз для данной подсети. Под шлюз будет занят один из адресов подсети
subnet_gateway Адрес шлюза используемый в подсети. Для назначения адреса автоматически, необходимо оставить пустым
subnet_use_dhcpНеобязательный параметр. Чтобы включить данную опцию используйте значение "on". Использовать DHCP для данной подсети. Под DHCP будет занят один из адресов подсети
gateway Шлюз
mask Маска сети
dns1 Первичный DNS сервер, используемый в сети
dns2 Вторичный DNS сервер, используемый в сети
dns_suffix DNS суффикс, используемый в сети
subnet_vdc_router 
vdc_router Подключить к марщрутизатору. При создании сеть будет подключена к выбранному маршрутизатору виртуального дата-центра
vdc_network Подключить к сети ВДЦ. Сеть будет подключена к выбранной сети виртуального дата-центра
network_pools 
network_dhcp 

Выключить

Функция: vdc.network.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.network.

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

Включить

Функция: vdc.network.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.network.

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

Virtual machines

Функция: vdc.vm

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

Список виртуальных серверов

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

ПараметрЗначение
idId
name Наименование
vm_groupГруппа
vmtempl Шаблон ВС
ostempl_nameШаблон ОС
external_ip Внешние IP
internal_ip Внутренние IP
ncpu_m Процессор, шт.
mem_mОперативная память, МиБ
disc_total_mДиск, ГиБ
statusСостояние

Доступ к консоли сервера

Функция: vdc.vm.webconsole

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

Редактирование виртуального сервера

Функция: vdc.vm.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • panelid — идентификатор в панели управления
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm)
    • дополнительные параметры запроса
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Для переменной используйте внутреннее имя значения: раздел Типы продуктов → выберите продукт — кнопка Параметры → выберите параметр → кнопка Значения → столбец Внутреннее имя.

ПараметрЗначение
name Наименование виртуального сервера
vmtempl Набор параметров виртуального сервера
source Базовый объект. Выберите базовый объект, на основе которого будет создан виртуальный сервер
ostempl Операционная система. Шаблон операционной системы, из которого будет создан виртуальный сервер
vdc_volume Диск. Можно выбрать только загрузочный диск не используемый ни одним из виртуальных серверов
vdc_volume_snapshot Снимок диска. На основе снимка будет создан новый диск, который будет подключен к виртуальному серверу
vdc_vm_snapshot Снимок виртуального сервера. На основе снимка будет создан новый виртуальный сервер
vdc_vm_group Группа для размещения виртуального сервера
vm_group_nameИмя группы виртуальных серверов
vdc_networkСеть виртуального дата-центра, к которой будет подключен создаваемый виртуальный сервер
create_volumeНеобязательный параметр. Чтобы включить данную опцию используйте значение "on". Для виртуального сервера будет создан диск указанного размера
disc Диск. Объем жесткого диска виртуального сервера
ncpu Процессоры. Количество процессоров виртуального сервера
mem Оперативная память. Объем оперативной памяти выделяемой виртуальному серверу
password Пароль доступа к виртуальному серверу
confirm Подтверждение

Имя диска

Функция: vdc.vm.volume

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

Список дисков, подключенных к виртуальному серверу

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

ПараметрЗначение
idId
name Имя диска
size Размер диска, ГиБ

Присоединение диска к виртуальному серверу

Функция: vdc.vm.volume.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.volume)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.volume)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
volumelist Имя диска, присоединяемого к виртуальномуу серверу

Отключить диск от виртуального сервера

Функция: vdc.vm.volume.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.volume.

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

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

Функция: vdc.vm.filter

Перезагрузить виртуальный сервер

Функция: vdc.vm.reboot

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

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

Остановить виртуальный сервер

Функция: vdc.vm.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

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

Сделать принудительную перезагрузку виртуального сервера

Функция: vdc.vm.hardreboot

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

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

Удалить виртуальный сервер

Функция: vdc.vm.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

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

Подключения к сетям виртуального дата-центра

Функция: vdc.vm.network

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

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

ПараметрЗначение
idId
network_name Имя сети
ip_addressIP-адрес
network_subnet Подсеть
mac MAC-адрес

Отключить виртуальный сервер от сети

Функция: vdc.vm.network.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.network.

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

Добавление нового подключения

Функция: vdc.vm.network.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.network)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.network)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
network Сеть виртуального дата-центра, к которой необходимо подключить виртуальный сервер

Внешние IP-адреса, подключенные к виртуальному серверу

Функция: vdc.vm.ip

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

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

ПараметрЗначение
idId
ipIP-адрес
status Состояние

Присоединение IP к виртуальному серверу

Функция: vdc.vm.ip.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.ip)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.vm).
    • elid — уникальный идентификатор (элемент id из функции vdc.vm.ip)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
iplist IP-адрес, присоединяемый к виртуальному серверу
port Порт виртуального сервера, к которому будет подключен внешний IP-адрес

Открепить IP от виртуального сервера

Функция: vdc.vm.ip.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.ip.

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

Запустить виртуальный сервер

Функция: vdc.vm.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.vm.

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

Имя диска

Функция: vdc.volume

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

Дисковые хранилища

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

ПараметрЗначение
idId
name Имя диска
size Размер диска, ГиБ
externalid ID диска
vdc_vm_name Виртуальный сервер
type Тип диска
bootable Загрузочный диск
ssСнимки
status Состояние

Снимки диска

Функция: vdc.volume.snapshot

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

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

ПараметрЗначение
idId
name Имя
externalidID снимка
vdc_volume Диск
status Состояние

Удалить

Функция: vdc.volume.snapshot.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.volume.snapshot.

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

Снимок

Функция: vdc.volume.snapshot.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.volume).
    • elid — уникальный идентификатор (элемент id из функции vdc.volume.snapshot)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.volume).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.volume).
    • elid — уникальный идентификатор (элемент id из функции vdc.volume.snapshot)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Имя. Наименование

Редактирование диска

Функция: vdc.volume.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.volume)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.volume)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Имя диска
type Тип диска
source_type Источник создания диска
ostemplОбраз, из которого будет создан диск
snapshot Снимок из которого будет создан диск
size Размер диска в гигабайтах
bootable Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Загрузочный диск

Удалить

Функция: vdc.volume.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.volume.

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

Выключить

Функция: vdc.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.

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

Включить

Функция: vdc.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.

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

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

Функция: vdc.filter

Виртуальный дата-центр

Функция: vdc.edit

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

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

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vdc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • panelid — идентификатор в панели управления
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vdc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
processingmodule Модуль обработки
autoprolong Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
createdate Дата заказа услуги
opendate Дата создания. Дата фактического начала действия услуги
expiredate Действует до. Срок действия услуги
scheduledclose Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Запланировано удаление по окончанию оплаченного периода
reboot Необязательный параметр. Чтобы включить данную опцию используйте значение "on".
note Комментарий к услуге, виден только сотрудникам провайдера
noexpense Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: vdc.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.

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

Заказ виртуального дата-центра

Функция: vdc.order.pricelist

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

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

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции vdc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции vdc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
datacenter Дата-центр, в котором будет открыта услуга

Установить фильтр по клиенту

Функция: vdc.setfilter

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

vdc.loadbalancer

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

Список балансировщиков

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

ПараметрЗначение
idId
name Наименование
externalid ID балансировщика
vmВиртуальный сервер
protocolПротокол
portПорт
method Метод
monitortype Протокол мониторинга
delayИнтервал, сек
retriesКоличество попыток
timeout Таймаут, сек
status Состояние

Редактировать балансировщик

Функция: vdc.loadbalancer.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование
subnet подсеть
protocol протокол
port порт. Значение должно быть от 1 до 65535
method Метод распределения трафика между участника пула
vm Виртуальные серверы, входящие в пул
monitortype Тип протокола мониторинга
delayИнтервал опроса, в секундах
retries Количество успешных проверок перед изменением состояния участника пула. Значение от 1 до 10
timeout Максимальное время ожидания подключения, в секундах

Виртуальные серверы, подключенные к балансировщику

Функция: vdc.loadbalancer.vm

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

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

ПараметрЗначение
idId
vm
subnetПодсеть

Присоединение виртуального сервера к балансировщику

Функция: vdc.loadbalancer.vm.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer.vm)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer.vm)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
vmВиртуальный сервер, присоединяемый к балансировщику

Удалить

Функция: vdc.loadbalancer.vm.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.loadbalancer.vm.

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

IP-адреса, подключенные к балансировщику

Функция: vdc.loadbalancer.ip

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

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

ПараметрЗначение
idId
ipIP-адрес
status Состояние

Присоединение IP к балансировщику

Функция: vdc.loadbalancer.ip.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer.ip)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.loadbalancer).
    • elid — уникальный идентификатор (элемент id из функции vdc.loadbalancer.ip)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
iplist IP-адрес, присоединяемый к балансировщику

Открепить IP от балансировщика

Функция: vdc.loadbalancer.ip.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.loadbalancer.ip.

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

Удалить балансировщик

Функция: vdc.loadbalancer.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.loadbalancer.

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

Routers

Функция: vdc.router

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

Список маршутизаторов виртуального дата-центра

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

ПараметрЗначение
idId
externalid Идентификатор маршрутизатора
name Наименование маршрутизатора
routertempl_nameКонфигурация
network Внешняя сеть
external_ip IP-адреса
status Состояние

Выключить

Функция: vdc.router.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.

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

Список пулов

Функция: vdc.router.lbp

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

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

ПараметрЗначение
idId
name Наименование
description Описание
members  Участников пула, шт
service Службы
port Порты
monitor_port Порт мониторинга
method Метод
interval Интервал
timeout Таймаут
status Состояние

Удаление пула

Функция: vdc.router.lbp.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.lbp.

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

Параметры пула

Функция: vdc.router.lbp.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.lbp)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.lbp)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование пула балансировщика нагрузки. Может содержать только быквы латинского алфавита, цифры, тире, нижнее подчеркивание и должно начинаться с буквы
description Произвольное описание пула
uri URI проверки доступности. URI для проверки доступности службы HTTP

Наименование тоннеля

Функция: vdc.router.vpn

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

Управление IPSec VPN тоннелями маршрутизатора

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

ПараметрЗначение
idId
name Наименование тоннеля
connection_type Тип подключения
local_ip_addressЛокальный IP-адрес
peer_ip_address Внешний IP-адрес
network_local Локальные сети
network_peer Внешние сети
encryption_protocolПротокол шифрования
status Состояние

Параметры IPSec VPN тоннеля маршрутизатора

Функция: vdc.router.vpn.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.vpn)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.vpn)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование
description Описание
connection_type Тип подключения IPSec VPN туннеля
vdc_router_peer Маршрутизатор виртуального дата-центра, для которого настраивается IPSec VPN туннель
vdc_network_local Локальные сети, подключенные к маршрутизатору
vdc_network_peer Внешние сети, подключенные к маршрутизатору виртуального дата-центра
peer_cidr Внешние сети, для которой настраивается IPSec VPN туннель в формате адрес_сети/маска, через пробел. Например 192.168.0.0/24 192.168.1.0/24
local_endpoint Локальная точка подключения. Интерфейс маршрутизатора, который будет использован для создания VPN соединения. Если необходимо использовать публичный IP адрес соединения, необходимо отметить опцию "Публичный IP-адрес"
local_endpoint_use_public_ipНеобязательный параметр. Чтобы включить данную опцию используйте значение "on".
peer_endpoint Внешняя точка подключения. Интерфейс маршрутизатора, который будет использован для создания VPN соединения. Если необходимо использовать публичный IP адрес соединения, необходимо отметить опцию "Публичный IP-адрес"
peer_endpoint_use_public_ip Необязательный параметр. Чтобы включить данную опцию используйте значение "on".
local_id Локальный ID IPSec VPN туннеля
peer_idВнешний ID IPSec VPN туннеля
peer_ip_address Внешний IP-адрес. Адрес внешней точки подключения
encryption_protocolПротокол шифрования соединения
shared_key Ключ шифрования. Допустимо использование латинских символов и цифр. Длина ключа должна быть не короче 32 и не длинее 128 символов
mtu MTU. Максимальный размер пакета для передачи по IPSec VPN туннелю

Удалить

Функция: vdc.router.vpn.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.vpn.

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

Выключить

Функция: vdc.router.vpn.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.vpn.

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

Включить

Функция: vdc.router.vpn.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.vpn.

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

Список серверов

Функция: vdc.router.lbs

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

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

ПараметрЗначение
idId
name Наименование
description Описание
ipIP-адрес
vdc_loadbalancer_pool_name Пул
service_name Имя службы
service_port Порт службы
service_persistence Метод
status Состояние

Выключить

Функция: vdc.router.lbs.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.lbs.

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

Удаление сервера

Функция: vdc.router.lbs.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.lbs.

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

Параметры сервера

Функция: vdc.router.lbs.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.lbs)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.lbs)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование сервера балансировщика нагрузки. Может содержать только быквы латинского алфавита, цифры, тире, нижнее подчеркивание и должно начинаться с буквы
descriptionПроизвольное описание сервера
vdc_networkСеть маршрутизатора, для которой будет активен балансировщик нагрузки
ipIP-адрес сервера балансировщика нагрузки
pool Пул настроек балансировщика нагрузки
use_log Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Включает журналирование трафика, проходящего через сервер балансировщика нагрузки

Включить

Функция: vdc.router.lbs.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.lbs.

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

Управление Firewall маршрутизатора

Функция: vdc.router.firewall

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

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

ПараметрЗначение
idId
name Наименование правила
source_desc Источник
destination_desc Адрес назначения
protocolПротокол
policy Политика
status Состояние

Удалить

Функция: vdc.router.firewall.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.firewall.

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

Выключить

Функция: vdc.router.firewall.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.firewall.

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

Редактирование правила Firewall

Функция: vdc.router.firewall.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.firewall)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.firewall)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование правила
protocol Протокол, к которому применяется правило
source Источник трафика. Допустимым значением может быть IP-адрес, CIDR, диапазон IP-адресов, "any","internal" и "external". Значение можно выбрать из списка или указать самостоятельно
source_port Порт источника. Значение можно выбрать из списка или указать самостоятельно
destination Адрес назначения трафика. Допустимым значением может быть IP-адрес, CIDR, диапазон IP-адресов, "any","internal" и "external". Значение можно выбрать из списка или указать самостоятельно
destination_port Порт адреса назначения. Значение можно выбрать из списка или указать самостоятельно
policy Политика, применяемая к трафику
use_log Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Опция включает ведение журнала трафика, попадаемого под правило

Включить

Функция: vdc.router.firewall.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.firewall.

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

Интерфейсы маршрутизатора

Функция: vdc.router.interface

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

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

ПараметрЗначение
idId
externalid Идентификатор интерфейса маршрутизатора
network Сеть
subnet Подсеть
fixedips IP-адрес
type Тип интерфейса
statusСостояние

Восстановление

Функция: vdc.router.interface.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.interface)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.interface)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
subnet Подсеть, к которой будет привязан маршрутизатор

Параметры интерфейса

Функция: vdc.router.interface.param

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

Удалить выделенные интерфейсы

Функция: vdc.router.interface.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.interface.

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

Включить

Функция: vdc.router.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.

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

Управление DHCP маршрутизатора

Функция: vdc.router.dhcp

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

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

ПараметрЗначение
idId
network Сеть дата-центра
ip_rangeДиапазон адресов
default_lease_time Время аренды по умолчанию
max_lease_time Максимальное время аренды
status Состояние

Выключить

Функция: vdc.router.dhcp.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.dhcp.

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

Включить

Функция: vdc.router.dhcp.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.dhcp.

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

Удалить

Функция: vdc.router.dhcp.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.dhcp.

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

Редактирование диапазона адресов

Функция: vdc.router.dhcp.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.dhcp)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.dhcp)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
vdc_network Сеть дата-центра, для которой активируется DHCP диапазон
ip_range Диапазон адресов, из которого будут выдаваться IP адреса
default_lease_time Время аренды IP-адреса по умолчанию
max_lease_time Максимальное время аренды IP-адреса

Редактирование маршрутизатора

Функция: vdc.router.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.router)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc).
    • elid — уникальный идентификатор (элемент id из функции vdc.router)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
name Наименование маршрутизатора
routertempl Конфигурация маршрутизатора
external_network Внешняя сеть, к которой будет подключен создаваемый маршрутизатор
use_dhcp Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Включить DHCP для маршрутизатора
use_firewall Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Включить Firewall для маршрутизатора
firewall_policy Политика обработки пакетов по умолчанию
use_vpn Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Включить использование VPN для маршрутизатора

Удалить выделенные маршрутизаторы

Функция: vdc.router.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.

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

Управление NAT маршрутизатора

Функция: vdc.router.nat

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

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

ПараметрЗначение
idId
network Сеть дата-центра
rule_type Тип правила
original_ip_range Исходный адрес/диапазон
original_port_desc Исходный порт
translated_ip_range Транслируемый адрес/диапазон
translated_port_desc Транслируемый порт
protocol Протокол
status Состояние

Выключить

Функция: vdc.router.nat.suspend

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.nat.

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

Удалить

Функция: vdc.router.nat.delete

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.nat.

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

Редактирование правила NAT

Функция: vdc.router.nat.edit

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

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.nat)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции vdc.router).
    • elid — уникальный идентификатор (элемент id из функции vdc.router.nat)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
vdc_network Сеть дата-центра, для которой применяется правило NAT
rule_type

Тип правила трансляции адресов.

  • SNAT — трансляция исходящих из внутренней сети запросов,
  • DNAT — трансляция входящих во внутреннюю сеть запросов
description Произвольное описание правила
protocol Протокол, для которого будет применяться правило NAT
original_ip_range Исходный адрес/диапазон. Для SNAT правила это внутренний IP-адрес или диапазон IP-адресов, для правила DNAT — внешний IP-адрес или диапазон IP-адресов. Значение можно выбрать из списка или указать самостоятельно
original_port Исходный порт, для которого выполняется трансляция. Значение можно выбрать из списка или указать самостоятельно
translated_ip_range Транслируемый адрес/диапазон. Для SNAT правила это внешний IP-адрес или диапазон IP-адресов, для правила DNAT — внутренний IP-адрес или диапазон IP-адресов. Значение можно выбрать из списка или указать самостоятельно
translated_port Транслируемый порт, по которому идет обращение. Значение можно выбрать из списка или указать самостоятельно

Включить

Функция: vdc.router.nat.resume

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.router.nat.

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

Синхронизация объектов услуги с объектами на стороне ВДЦ

Функция: vdc.sync

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

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции vdc.

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

Войти в панель с правами пользователя

Функция: vdc.su

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