Get Instance Details

GET 
/backend/api/openstack/instances/:instance_id

Host: https://core.ocplanet.cloud

Retrieve detailed information about a specific OpenStack instance identified by its unique ID.

Request

Responses

200

application/json

Schema

Schema

id uuidrequired
allocation_pools arrayrequired
cidr stringrequired
dns_nameservers arrayrequired
host_routes arrayrequired
gateway_ip nullrequired
name stringrequired
description nullrequired
subnetpool_id nullrequired
ip_version integerrequired
enable_dhcp booleanrequired
created_at nullrequired
updated_at nullrequired
project uuidrequired
net_details objectrequired
grouped_ips object[]required
Array [
ipv4s object[]required
Array [
ip_address stringrequired
subnet_id stringrequired
]
ipv6s object[]required
Array [
ip_address stringrequired
subnet_id stringrequired
]
network_name stringrequired
]
ports object[]required
Array [
end_user_has_access booleanrequired
floating_ips object[]required
Array [
id uuid
floating_ip_address string
]
id stringrequired
ipv4s object[]required
Array [
ip_address stringrequired
subnet_id stringrequired
]
ipv6s object[]required
Array [
ip_address stringrequired
subnet_id stringrequired
]
name uuidrequired
network uuidrequired
]
storage_details objectrequired
hide_local_storage booleanrequired
local_storage integerrequired
volume_attachments arrayrequired
traffic_type stringrequired

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allocation_pools": [
    null
  ],
  "cidr": "string",
  "dns_nameservers": [
    null
  ],
  "host_routes": [
    null
  ],
  "name": "string",
  "ip_version": 0,
  "enable_dhcp": true,
  "project": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "net_details": {
    "grouped_ips": [
      {
        "ipv4s": [
          {
            "ip_address": "string",
            "subnet_id": "string"
          }
        ],
        "ipv6s": [
          {
            "ip_address": "string",
            "subnet_id": "string"
          }
        ],
        "network_name": "string"
      }
    ],
    "ports": [
      {
        "end_user_has_access": true,
        "floating_ips": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "floating_ip_address": "string"
          }
        ],
        "id": "string",
        "ipv4s": [
          {
            "ip_address": "string",
            "subnet_id": "string"
          }
        ],
        "ipv6s": [
          {
            "ip_address": "string",
            "subnet_id": "string"
          }
        ],
        "name": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "network": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ]
  },
  "storage_details": {
    "hide_local_storage": true,
    "local_storage": 0,
    "volume_attachments": [
      null
    ]
  },
  "traffic_type": "string"
}

Example

{
  "id": "1666a5a6-1ba1-43a4-ae4e-3d24d7015e98",
  "name": "instance 1",
  "allowed_actions": [
    "shutoff",
    "reboot",
    "resize",
    "rescue",
    "rebuild",
    "console",
    "rename",
    "create_snapshot",
    "attach_volume",
    "boot_from_iso",
    "shelve",
    "associate_ip",
    "dissociate_ip",
    "change_password"
  ],
  "access_ip": "10.0.1.91",
  "uuid": "1666a5a6-1ba1-43a4-ae4e-3d24d7015e98",
  "created": "2024-03-19T09:38:29Z",
  "display_status": "Running",
  "display_task": null,
  "description": null,
  "image": {
    "id": "2b979045-4e10-45c9-805c-c95be46a37b9",
    "tags": [],
    "client": null,
    "properties": {
      "owner_specified.openstack.md5": "",
      "owner_specified.openstack.sha256": "",
      "owner_specified.openstack.object": "images/Centos-7",
      "hw_qemu_guest_agent": "yes",
      "os_hidden": false,
      "os_hash_algo": "sha512",
      "os_hash_value": "1b29cd42a53a3b0807962c1c9fbbf7fb360e0d95bb0c962c15fd9fa27ad13e908f45d81558a273ecdc4a5db1b7b3ae8cd14678b56e17e8d7ee5f588d36a8a401",
      "stores": "rbd"
    },
    "is_iso": false,
    "display_name": "Centos 7 (x64)",
    "cleanup_date": null,
    "assigned_to_flavor": true,
    "related_instance": null,
    "name": "Centos 7 (x64)",
    "type": "template",
    "status": "active",
    "size": 902889472,
    "created_at": "2023-12-30T11:54:35Z",
    "updated_at": "2023-12-30T11:57:43Z",
    "deleted_at": null,
    "os_distro": "centos",
    "hypervisor_type": null,
    "os_version": "7",
    "architecture": null,
    "min_disk": 0,
    "min_ram": 0,
    "protected": false,
    "visibility": "public",
    "container_format": "bare",
    "disk_format": "qcow2",
    "hw_qemu_guest_agent": true,
    "instance_uuid": null,
    "volume_snapshot_uuid": null,
    "region": "ua-central-1",
    "reseller_resources": null,
    "used_by_resellers": []
  },
  "region": "ua-central-1",
  "region_obj": {
    "id": "default",
    "description": "",
    "enabled": true,
    "enable_volumes": true,
    "enable_snapshots": true,
    "is_default": true
  },
  "flavor": {
    "id": "4d429bcd-252c-4522-9ed0-4a24d6d8249e",
    "memory_gb": 1,
    "flavor_group": null,
    "name": "v1.m1",
    "description": "v1.m1",
    "memory_mb": 1024,
    "vcpus": 1,
    "swap": 0,
    "root_gb": 10,
    "ephemeral_gb": 0,
    "out_of_stock": false,
    "properties": "{}",
    "region": "ua-central-1",
    "reseller_resources": null,
    "assigned_cluster_templates": [],
    "used_by_resellers": []
  },
  "net_details": {
    "grouped_ips": [
      {
        "network_name": "network94532",
        "ipv4s": [
          {
            "ip_address": "10.0.1.91",
            "subnet_id": "04830e34-ee2b-4257-8c25-fddcd3c3eeba"
          }
        ],
        "ipv6s": []
      }
    ],
    "ports": [
      {
        "id": "fb770ca8-3d8d-4166-b06e-6c7396460fda",
        "name": "fb770ca8-3d8d-4166-b06e-6c7396460fda",
        "network": "d76c58ea-98ca-4abe-a9b9-0a04f1740a71",
        "ipv4s": [
          {
            "ip_address": "10.0.1.91",
            "subnet_id": "04830e34-ee2b-4257-8c25-fddcd3c3eeba"
          }
        ],
        "ipv6s": [],
        "floating_ips": [
          {
            "id": "3d86bdf8-3452-45e2-a6c1-04044cf3f3d3",
            "floating_ip_address": "217.147.172.156"
          }
        ],
        "end_user_has_access": true
      }
    ]
  },
  "project": "50caa053ebc847c39b9c3149c746f0fa",
  "status": "active",
  "booted_from_iso": false,
  "locked": false,
  "current_cycle_traffic": 1,
  "current_month_traffic": 1,
  "traffic_type": "all",
  "hostId": "5edc2161bc58cd4920fd84600b7ef1d1b4a4b68bef7bcaf209911915",
  "host_name": "s10",
  "storage_details": {
    "hide_local_storage": false,
    "local_storage": 10,
    "volume_attachments": []
  },
  "availability_zone": "nova",
  "client": {
    "id": 933016,
    "name": "EN EN",
    "display": "EN EN #933016"
  },
  "tags": []
}

Loading...