Invapi API FAQ¶

En este artículo

• Algoritmo de pedido instantáneo de servidores con eq/order_instance
• Reinstalación de un servidor mediante eq/order_instance

Algoritmo de pedido instantáneo de servidores con eq/order_instance¶

1. Cree una client API key;

2. Elija la ubicación del servidor: NL/US/FI/DE/IS/TR/UK/ES/IT/PL/CH (Países Bajos, EE. UU., Finlandia, Alemania, Islandia, Turquía, Reino Unido, España, Italia, Polonia, Suiza);

3. Utilice la solicitud presets/list para determinar el ID del preset para el despliegue.

   Este ID se utilizará posteriormente como instance_id o preset. Por ejemplo, si "id": 108, los valores son instance_id=108 y preset=108;

4. Utilice la solicitud os/list para determinar el os_id o os_name del sistema operativo que desea instalar, utilizando el ID de instancia del paso 3 o su alias. Por ejemplo, para Ubuntu 22.04, este valor se devolverá en la respuesta como "id": 187 y "alias": ubuntu. También puede encontrar IDs de SO e información sobre en qué tipos de servidor están disponibles en la lista de sistemas operativos compatibles actualmente;

   Nota

   Si no desea instalar un sistema operativo durante el despliegue, especifique own_os=1 más adelante.

5. Utilice la solicitud [software/list](../apidocs/software.md] para identificar el software disponible para esta instancia y obtener su ID (el parámetro soft_id). Por ejemplo, para el CMS WordPress, el valor en la salida de la solicitud será "id": 20. Puede encontrar una lista de software instalable y sus parámetros de instalación (ID, tipo de servidor, RAM y espacio en disco requeridos, número de núcleos de CPU, etc.) en la lista de software compatible;

   Nota

   Puede omitir la preinstalación de software durante el despliegue si desea hacerlo manualmente más tarde.

6. Utilice la solicitud traffic_plans/list para obtener el ID del plan de tráfico de red para su servidor. Por ejemplo, para el plan 3Tb traffic (1Gbps) VM, la llamada devolverá "id": 25;

7. Obtenga un token de sesión $HOSTKEY_TOKEN a través de la solicitud auth/login;

8. Realice el pedido del servidor insertando los datos obtenidos en los pasos 2-7 en la solicitud eq/order_instance. Debe especificar su contraseña root, el periodo de facturación del servidor deploy_period (mensual, trimestral, semestral o anual) y si desea una notificación por correo electrónico tras el despliegue mediante deploy_notify (recomendamos establecer esto en true por defecto).

Se pueden especificar parámetros adicionales opcionales como se describe en la llamada eq/order_instance.

A continuación, se muestra un ejemplo de pedido de un servidor con WordPress (id=20) en Debian 11 (id=108):

curl -s "https://invapi.hostkey.com/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 seleccionará/creará el servidor correspondiente en la ubicación especificada y procederá con el despliegue. Antes de cualquier instalación, se realizará una comprobación de fondos suficientes en el saldo de crédito (si están habilitados los pagos automáticos desde el saldo de crédito) o se emitirá una factura. Si la instalación es exitosa, el nuevo servidor se vinculará a la cuenta del cliente. El cliente será notificado por correo electrónico si así lo solicita. Todas las licencias pagadas se añadirán como complementos del pedido.

{
"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"
}

Reinstalación de un servidor mediante eq/order_instance¶

La reinstalación de un servidor se realiza de forma similar al pedido de uno; la única diferencia es pasar un parámetro id adicional en la solicitud eq/order_instance—el ID del servidor que se va a reinstalar desde Invapi—y no utilizar el parámetro preset. Durante una reinstalación, puede elegir un sistema operativo y software preinstalado diferentes, o realizar una reinstalación "limpia" estableciendo el parámetro own_os=1 (en cuyo caso debe establecer os_id = 0).

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=order_instance" \
--data "token=$HOSTKEY_TOKEN" \
--data "hostname={Hostname}" \
--data "os_id={OS ID}" \
--data "soft_id={Software ID}" \
--data "root_pass={root password}" \
--data "ssh_key={public SSH key}" \
--data "post_install_script=" \
--data "own_os=" \
--data "root_size=100" \
--data "location_name={Server location with specified ID}" \
--data "id={Invapi Server ID}" // La presencia del ID activa el proceso de reinstalación del servidor.

{
"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"}

Por ejemplo, supongamos que queremos reinstalar nuestro servidor del ejemplo anterior a Rocky Linux 9 (id=205) y Grafana (id=18). La solicitud sería la siguiente:

curl -s "https://invapi.hostkey.com/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", // clave asíncrona
    "deploy_status": "reinstall",
    "id": 32645,
    "os_name": "RockyLinux 9",
    "soft_name": "Grafana"
}

Al utilizar esta clave asíncrona (el campo callback), podemos realizar un seguimiento del proceso de reinstalación mediante acciones asíncronas.

{
    "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"
}