Часто задаваемые вопросы по использованию API Invapi¶

В этой статье

• Алгоритм заказа моментального сервера с помощью eq/orderinstance
• Переустановка сервера через eq/orderinstance

Алгоритм заказа моментального сервера с помощью eq/order_instance¶

1. Cоздайте клиентский API-ключ;

2. Определитесь с локацией заказа сервера: RU/NL/US/FI/DE/IS/TR/UK/ES/IT/PL/CH (Россия, Нидерланды, США, Финляндия, Германия, Исландия, Турция, Великобритания, Испания, Италия, Польша, Швейцария);

3. С помощью запроса presets/list определите ID пресета для развертывания.

   Этот ID далее будет использоваться как instance_id или preset). Например при "id": 108 значения instance_id=108 и preset=108;

4. С помощью запроса os/list определите os_id или os_name нужной к установке операционной системы, используя ID инстанса из п.3 или ее алиас. Например для Ubuntu 22.04 это значение будет определено в ответе на запрос как "id": 187 и "alias": ubuntu. Также ID ОС и информацию, на каких типах серверов она доступна, можно найти в списке текущих поддерживаемых ОС;

   Примечание

   Если вы не хотите ставить на сервер ОС при его развертывании, укажите позже параметр own_os=1.

5. С помощью запроса software/list определите для данного инстанса возможное к развертыванию программное обеспечение и получите его ID (далее параметр soft_id). Например для СMS Wodrpress в выводе запроса это значение будет "id": 20. Доступное к установке ПО и его параметры для установки (id, тип сервера, необходимые объемы памяти и диска, число ядер процессора и т.п.) можно найти в списке поддерживаемого ПО;

   Примечание

   Вы можете не предустанавливать ПО при развертывании, если хотите сделать это позже самостоятельно.

6. С помощью запроса traffic_plans/list получите ID тарифного плана сетевого трафика для вашего сервера. Например для плана 3Tb traffic (1Gbps) VM вызов вернет значение "id": 25;

7. Получите сессионный токен $HOSTKEY_TOKEN через запрос auth/login;

8. Закажите сервер, вставив в запрос eq/order_instance данные полученые в п.п. 2-7. Обязательно укажите ваш пароль root, период оплаты сервера deploy_period (на месяц, квартал, 6 месяцев или за год), необходимость уведомления на почту о развертывании deploy_notify (рекомендуем ставить true по умолчанию).

По желанию можно указать дополнительные параметры, описаные в вызове eq/order_instance.

Ниже приведен пример заказа сервера с Wordpress (id=20) на Debian 11 (id=108):

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=order_instance" \
--data "token=eeee51003b1d81d2eca65660735c0531" \
--data "deploy_period=monthly" \
--data "deploy_notify=true" \
--data "preset=108" \
--data "location_name=NL" \
--data "os_id=180" \
--data "soft_id=20" \
--data "traffic_plan=25" \
--data "root_pass=mdLus8Ng" \

{
    "result": "OK",
    "action": "order_instance",
    "invoice": 50062,
    "status": "Paid"
}

Invapi выберет/создаст соответствующий сервер в определенном месте и продолжит его развертывание. Перед любой установкой будет произведена проверка наличия средств на кредитном счете (при установленном параметре автоплатежей с кредитного баланса) или выставлен счет на оплату. Если установка пройдет успешно, новый сервер будет привязан к учетной записи клиента. По запросу клиент будет уведомлен по электронной почте. Все платные лицензии будут добавлены в качестве дополнений к заказу.

{
"result": -1,
"error": "reinstall: extra software Odoo (#49) is not compatible with Ubuntu 22.04"
}

{
"result": "OK",
"scope": "Autodeploy completed, check VRI-208-64405",
"context": {
    "action": "deploy_vm",
    "id": "32645",
    "location": "NL",
    "ip": "176.222.34.23",
    "ip_ipmi": "0.0.0.0"
},
"debug": "0",
"key": "9889fcb51255146e04224205c04976e8"
}

Переустановка сервера через eq/order_instance¶

Переустановка сервера производится аналогично его заказу и отличается только передачей в запросе eq/order_instance дополнительного параметра id - ID переустанавливаемого сервера из Invapi и неиспользовании параметра preset. При переустановке вы можете выбрать другую операционную систему и предустанавливаемое программное обеспечение или сделать переустановку "с чистого листа", установив параметр own_os=1 (при это обязательно задать os_id = 0).

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=order_instance" \
--data "token=$HOSTKEY_TOKEN" \
--data "hostname={Имя хоста}" \
--data "os_id={ID операционной системы}" \
--data "soft_id={ID программного обеспечения}" \
--data "root_pass={пароль root}" \
--data "ssh_key={открытый SSH ключ}" \
--data "post_install_script=" \
--data "own_os=" \
--data "root_size=100" \
--data "location_name={локация сервера с заданным ID}" \
--data "id={ID сервера из Invapi}" // Наличие ID запустит процесс переустановки сервера.

{
"result": -1,
"error": "reinstall: extra software Odoo (#49) is not compatible with Ubuntu 22.04"
}

{"result":-1,"error":"another reinstall in progress for XXXXX, please wait"}

Например мы хотим переставить наш сервер из предыдущего примера на Rocky Linux 9 (id=205) и Grafana (id=18). Запрос будет следующий:

curl -s "https://invapi.hostkey.ru/eq.php" -X POST \
--data "action=order_instance" \
--data "token=5e731472b19f25c7fe61c9eb5c2ea4e3" \
--data "deploy_notify=true" \
--data "os_id=205" \
--data "soft_id=18" \
--data "root_pass=mnN48Dl@4" \
--data "location_name=NL" \
--data "id=32645"

{
    "result": "OK",
    "action": "order_instance",
    "callback": "e2fbe5f43796d4139983b695271da9aa", // асинхронный ключ
    "deploy_status": "reinstall",
    "id": 32645,
    "os_name": "RockyLinux 9",
    "soft_name": "Grafana"
}

Используя данный асинхронный ключ (поле callback), мы можем отследить процесс переустановки, используя асинхронные действия.

{
    "result": "OK",
    "scope": "{\"result\":\"deploy_done\"}",
    "context": {
        "action": "reinstall_vm",
        "id": "32645",
        "location": "NL",
        "ip": "176.222.34.23",
        "ip_ipmi": "0.0.0.0",
        "reinstall": 1
    },
    "debug": "",
    "key": "a129bad13781bdf5790746064aba0af6"
}