REST - Adresy IP

Listowanie adresów IP

Zapytanie

GET /v2/ipv4-addresses/

Zwraca tablicę z listą istniejących adresów IP.

Odpowiedź

{
    "success": true,
    "ipv4_addresses": [
        {
            "id": "$ip_id",
            "ipv4_address": "$ip_address",
            "cost_per_hour": "$cost_per_hour",
            "owner": {
                "id": "$owner_id",
                "name": "$owner_name"
            },
            "zone": {
                "id": "$zone_id",
                "name": "$zone_name"
            },
            "virtual_machine": {
                "id": "$vm_id",
                "label": "$vm_name"
            },
            "attach_time": "$ip_date",
            "dhcp": $ip_dhcp
        }
  ]
}   

Zwracane informacje

• $ip_id (string) - UUID adresu IP
• $ip_address (string) - adres IP
• $cost_per_hour (float) - koszt adresu IP na godzinę
• $owner_id (string) - UUID właściciela adresu IP
• $owner_name (string) - nazwa właściciela adresu IP
• $zone_id (string) - UUID strefy w jakiej jest zlokalizowany adres IP
• $zone_name (string) - nazwa strefy w jakiej jest zlokalizowany adres IP
• $vm_id (string) - UUID serwera wirtualnego do którego jest podłączony adres IP
• $vm_name (string) - nazwa serwera wirtualnego do którego jest podłączony adres IP
• $ip_date (string) - data i godzina podłączenia adresu IP
• $ip_dhcp (bool) - informacja czy adres IP jest uzyskiwany z DHCP

Pobieranie informacji o adresie IP

Zapytanie

GET GET /v2/ipv4-addresses/$IP_ID

Zwraca informacje o adresie IP, o podanym $IP_ID.

Odpowiedź

{
    "success": true,
    "ipv4_address": {
        "id": "$ip_id",
        "ipv4_address": "$ip_address",
        "cost_per_hour": "$cost_per_hour",
        "owner": {
            "id": "$owner_id",
            "name": "$owner_name"
        },
        "zone": {
            "id": "$zone_id",
            "name": "$zone_name"
        },
        "virtual_machine": {
            "id": "$vm_id",
            "label": "$vm_name"
        },
        "attach_time": "$ip_date",
        "dhcp": $ip_dhcp
    }
}   

Zwracane informacje

• $ip_id (string) - UUID adresu IP
• $ip_address (string) - adres IP
• $cost_per_hour (float) - koszt adresu IP na godzinę
• $owner_id (string) - UUID właściciela adresu IP
• $owner_name (string) - nazwa właściciela adresu IP
• $zone_id (string) - UUID strefy w jakiej jest zlokalizowany adres IP
• $zone_name (string) - nazwa strefy w jakiej jest zlokalizowany adres IP
• $vm_id (string) - UUID serwera wirtualnego do którego jest podłączony adres IP
• $vm_name (string) - nazwa serwera wirtualnego do którego jest podłączony adres IP
• $ip_date (string) - data i godzina podłączenia adresu IP
• $ip_dhcp (bool) - informacja czy adres IP jest uzyskiwany z DHCP

Dodawanie adresu IP

Zapytanie

PUT /v2/ipv4-addresses

Zawartość zapytania

{
  "zone_id": "$zone_id"
}

Opis parametrów

• $zone_id (string) - UUID strefy w jakiej ma być zlokalizowany adres IP

Odpowiedź

{
    "success": true,
    "ipv4_address": {
        "id": "$ip_id",
        "ipv4_address": "$ip_address",
        "cost_per_hour": "$cost_per_hour",
        "owner": {
            "id": "$owner_id",
            "name": "$owner_name"
        },
        "zone": {
            "id": "$zone_id",
            "name": "$zone_name"
        },
        "virtual_machine": {
            "id": "$vm_id",
            "label": "$vm_name"
        },
        "attach_time": "$ip_date",
        "dhcp": $ip_dhcp
    }
}   

Zwracane informacje

• $ip_id (string) - UUID adresu IP
• $ip_address (string) - adres IP
• $cost_per_hour (float) - koszt adresu IP na godzinę
• $owner_id (string) - UUID właściciela adresu IP
• $owner_name (string) - nazwa właściciela adresu IP
• $zone_id (string) - UUID strefy w jakiej jest zlokalizowany adres IP
• $zone_name (string) - nazwa strefy w jakiej jest zlokalizowany adres IP
• $vm_id (string) - UUID serwera wirtualnego do którego jest podłączony adres IP
• $vm_name (string) - nazwa serwera wirtualnego do którego jest podłączony adres IP
• $ip_date (string) - data i godzina podłączenia adresu IP
• $ip_dhcp (bool) - informacja czy adres IP jest uzyskiwany z DHCP czy nie

Podłączenie adreesu IP do serwera wirtualnego

Zapytanie

POST /v2/ipv4-addresses/$IP_ID/attach

Podłączanie adresu IP o ID $IP_ID, do wirtualnego serwera.

Zawartość zapytania

{
   "virtual_machine_id": "$vm_id"
}

Opis parametrów

• $vm_id (string) - UUID wirtualnego serwera

Odpowiedź

{  
  "success":true
}

Odłączanie adresu IP od serwera wirtualnego

Zapytanie

POST /v2/ipv4-addresses/$IP_ID/detach

Dodaje zadanie odłączenia adresu IP o $IP_ID od wirtualnego serwera. Adres IP musi być podłączony do wirtualnego serwera, aby operacja się powiodła.

Odpowiedź

{  
  "success":true
}

Usuwanie adresu IP

Zapytanie

DELETE /v2/ipv4-addresses/$IP_ID

Dodaje zadanie usunięcia adresu IP $IP_ID. Jeżeli adres IP jest podłączony do wirtualnego serwera, zostanie od niego automatycznie odłączony.

Odpowiedź

{  
  "success":true
}

Updated on 05 Sep 2023