Get Images

GET 
/backend/api/openstack/images

Host: https://core.ocplanet.cloud

Access information related to images within the OpenStack context.

Request

Query Parameters

filtering string
ordering string
page string
page_size string

Responses

200

application/json

Schema

Schema

count integerrequired
filter_options objectrequired
hypervisor_type object[]required
Array [
display stringrequired
value stringrequired
]
status object[]required
Array [
display stringrequired
value stringrequired
]
visibility object[]required
Array [
display stringrequired
value stringrequired
]
next nullstringrequired
objects object[]required
Array [
backup_type string
base_image_ref string
boot_roles string
hw_cdrom_bus string
hw_disk_bus string
hw_input_bus string
hw_machine_type string
hw_pointer_model string
hw_qemu_guest_agent stringrequired
hw_video_model string
hw_vif_model string
image_location string
image_state string
image_type string
instance_uuid stringrequired
owner_id string
owner_project_name string
owner_specified.openstack.md5 string
owner_specified.openstack.object string
owner_specified.openstack.sha256 string
owner_user_name string
user_id string
]
pageNo integerrequired
permissions objectrequired
images.create booleanrequired
images.deactivate booleanrequired
images.destroy booleanrequired
images.download booleanrequired
images.list booleanrequired
images.reactivate booleanrequired
images.retrieve booleanrequired
images.update booleanrequired
previous nullstringrequired
totalCount integerrequired

Example (from schema)

{
  "count": 0,
  "filter_options": {
    "hypervisor_type": [
      {
        "display": "string",
        "value": "string"
      }
    ],
    "status": [
      {
        "display": "string",
        "value": "string"
      }
    ],
    "visibility": [
      {
        "display": "string",
        "value": "string"
      }
    ]
  },
  "objects": [
    {
      "backup_type": "string",
      "base_image_ref": "string",
      "boot_roles": "string",
      "hw_cdrom_bus": "string",
      "hw_disk_bus": "string",
      "hw_input_bus": "string",
      "hw_machine_type": "string",
      "hw_pointer_model": "string",
      "hw_qemu_guest_agent": "string",
      "hw_video_model": "string",
      "hw_vif_model": "string",
      "image_location": "string",
      "image_state": "string",
      "image_type": "string",
      "instance_uuid": "string",
      "owner_id": "string",
      "owner_project_name": "string",
      "owner_specified.openstack.md5": "string",
      "owner_specified.openstack.object": "string",
      "owner_specified.openstack.sha256": "string",
      "owner_user_name": "string",
      "user_id": "string"
    }
  ],
  "pageNo": 0,
  "permissions": {
    "images.create": true,
    "images.deactivate": true,
    "images.destroy": true,
    "images.download": true,
    "images.list": true,
    "images.reactivate": true,
    "images.retrieve": true,
    "images.update": true
  },
  "totalCount": 0
}

Example

{
  "count": 2,
  "next": null,
  "previous": null,
  "objects": [
    {
      "id": "4747270d-61c9-4bb6-9b01-f6dd915f0560",
      "tags": [],
      "client": {
        "id": 933016,
        "name": "EN EN",
        "display": "EN EN #933016"
      },
      "properties": {
        "owner_specified.openstack.md5": "",
        "owner_specified.openstack.sha256": "",
        "owner_specified.openstack.object": "images/Centos-7",
        "hw_qemu_guest_agent": "yes",
        "base_image_ref": "2b979045-4e10-45c9-805c-c95be46a37b9",
        "owner_user_name": "admin",
        "owner_project_name": "933016",
        "boot_roles": "reader,member,load-balancer_member,_member_",
        "hw_machine_type": "pc",
        "hw_cdrom_bus": "ide",
        "hw_disk_bus": "virtio",
        "hw_input_bus": "usb",
        "hw_pointer_model": "usbtablet",
        "hw_video_model": "virtio",
        "hw_vif_model": "virtio",
        "instance_uuid": "81ddeb48-937b-4e54-8b37-091bfcabf18e",
        "user_id": "6b60b80afb7249c7b5f9d6e9b25ef1f6",
        "image_type": "backup",
        "backup_type": "manual",
        "image_location": "snapshot",
        "owner_id": "50caa053ebc847c39b9c3149c746f0fa",
        "image_state": "available"
      },
      "is_iso": false,
      "display_name": "u",
      "cleanup_date": "2024-04-03T07:52:50Z",
      "assigned_to_flavor": true,
      "related_instance": null,
      "name": "u",
      "type": "backup",
      "status": "active",
      "size": 10737418240,
      "created_at": "2024-03-20T07:52:50Z",
      "updated_at": "2024-03-20T09:08:42Z",
      "deleted_at": null,
      "os_distro": "centos",
      "hypervisor_type": null,
      "os_version": "7",
      "architecture": null,
      "min_disk": 10,
      "min_ram": 0,
      "protected": false,
      "visibility": "private",
      "container_format": "bare",
      "disk_format": "raw",
      "hw_qemu_guest_agent": true,
      "instance_uuid": "81ddeb48-937b-4e54-8b37-091bfcabf18e",
      "volume_snapshot_uuid": null,
      "region": "ua-central-1",
      "reseller_resources": null,
      "used_by_resellers": []
    },
    {
      "id": "66f0e855-c006-47ae-bf91-d36b4446042a",
      "tags": [],
      "client": {
        "id": 933016,
        "name": "EN EN",
        "display": "EN EN #933016"
      },
      "properties": {
        "owner_specified.openstack.md5": "",
        "owner_specified.openstack.sha256": "",
        "owner_specified.openstack.object": "images/Centos-7",
        "hw_qemu_guest_agent": "yes",
        "base_image_ref": "2b979045-4e10-45c9-805c-c95be46a37b9",
        "owner_user_name": "admin",
        "owner_project_name": "933016",
        "boot_roles": "member,_member_,load-balancer_member,reader",
        "hw_machine_type": "pc",
        "hw_cdrom_bus": "ide",
        "hw_disk_bus": "virtio",
        "hw_input_bus": "usb",
        "hw_pointer_model": "usbtablet",
        "hw_video_model": "virtio",
        "hw_vif_model": "virtio",
        "instance_uuid": "1666a5a6-1ba1-43a4-ae4e-3d24d7015e98",
        "user_id": "6b60b80afb7249c7b5f9d6e9b25ef1f6",
        "image_type": "snapshot",
        "image_location": "snapshot",
        "owner_id": "50caa053ebc847c39b9c3149c746f0fa",
        "image_state": "available"
      },
      "is_iso": false,
      "display_name": "LB",
      "cleanup_date": "2024-04-03T07:51:02Z",
      "assigned_to_flavor": true,
      "related_instance": {
        "id": "1666a5a6-1ba1-43a4-ae4e-3d24d7015e98",
        "name": "evdokimov@onepointcollab.com"
      },
      "name": "LB",
      "type": "snapshot",
      "status": "active",
      "size": 10737418240,
      "created_at": "2024-03-20T07:51:02Z",
      "updated_at": "2024-03-20T07:55:16Z",
      "deleted_at": null,
      "os_distro": "centos",
      "hypervisor_type": null,
      "os_version": "7",
      "architecture": null,
      "min_disk": 10,
      "min_ram": 0,
      "protected": false,
      "visibility": "private",
      "container_format": "bare",
      "disk_format": "raw",
      "hw_qemu_guest_agent": true,
      "instance_uuid": "1666a5a6-1ba1-43a4-ae4e-3d24d7015e98",
      "volume_snapshot_uuid": null,
      "region": "ua-central-1",
      "reseller_resources": null,
      "used_by_resellers": []
    }
  ],
  "totalCount": 2,
  "pageNo": 1,
  "permissions": {
    "images.list": true,
    "images.retrieve": true,
    "images.create": true,
    "images.destroy": true,
    "images.download": true,
    "images.update": true,
    "images.deactivate": true,
    "images.reactivate": true
  },
  "filter_options": {
    "status": [
      {
        "display": "Active",
        "value": "active"
      },
      {
        "display": "Deactivated",
        "value": "deactivated"
      },
      {
        "display": "Deleted",
        "value": "deleted"
      },
      {
        "display": "Killed",
        "value": "killed"
      },
      {
        "display": "Pending delete",
        "value": "pending_delete"
      },
      {
        "display": "Queued",
        "value": "queued"
      },
      {
        "display": "Saving",
        "value": "saving"
      }
    ],
    "hypervisor_type": [
      {
        "display": "hyperv",
        "value": "hyperv"
      },
      {
        "display": "ironic",
        "value": "ironic"
      },
      {
        "display": "lxc",
        "value": "lxc"
      },
      {
        "display": "qemu",
        "value": "qemu"
      },
      {
        "display": "uml",
        "value": "uml"
      },
      {
        "display": "vmware",
        "value": "vmware"
      },
      {
        "display": "xen",
        "value": "xen"
      },
      {
        "display": "kvm",
        "value": "kvm"
      },
      {
        "display": "lxd",
        "value": "lxd"
      }
    ],
    "visibility": [
      {
        "display": "Community",
        "value": "community"
      },
      {
        "display": "Private",
        "value": "private"
      },
      {
        "display": "Public",
        "value": "public"
      },
      {
        "display": "Shared",
        "value": "shared"
      }
    ]
  }
}

Loading...