Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 4.4

Skip to end of metadata
Go to start of metadata

Contents:

All Virtual Machines access point

Thie All Virtual Machines Resource enables the user to retrieve all the VMs she can access in the cloud, using a single query. This resource supports GET requests only because it is an access point for a group of resources. The VM entities in the response include links that you can use to access the VMs, their virtual datacenters, and their virtual resources.

If you have the appropriate permissions, you can also retrieve VMs through infrastructure, either at the top level or per physical machine.

Main URI of the Resource

This class operates mainly over the Resource URI: /cloud/virtualmachines

Exposed Methods

List virtual machines of the user

Returns all the virtual machines in the cloud that the current user has access to.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

Synopsis: GET http://example.com/api/cloud/virtualmachines
Roles Required: VDC_ENUMERATE,VDC_MANAGE_VAPP,VAPP_CUSTOMISE_SETTINGS,VAPP_ASSIGN_NETWORK,VAPP_PERFORM_ACTIONS,VAPP_DEPLOY_UNDEPLOY,VAPP_CREATE_STATEFUL,VAPP_ASSIGN_VOLUME,MANAGE_HARD_DISKS,VAPP_CREATE_INSTANCE
Request Headers: Accept:  application/vnd.abiquo.virtualmachines+json; version=4.4; application/vnd.abiquo.virtualmachines+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

startwith

false

0

number of the page to start from

by

false

name

by default ordered by name

has

false

 

name filter

limit

false

25

number of items to retrieve

asc

false

true

whether the sorting of the list is ascending or descending

Request Message Body Entity:
Response Message Body Entity: VirtualMachines Media Type
Request Example:

 Click here to show or hide the request example


GET_cld_vms_AC_vms_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/cloud/virtualmachines \ 
	 -H 'Accept:application/vnd.abiquo.virtualmachines+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 2, 
  "links": [
    {
      "href": "http://localhost:9009/api/cloud/virtualmachines?limit=25&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/cloud/virtualmachines?startwith=0&limit=25&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/4300/racks/1184/machines/1275", 
          "type": "application/vnd.abiquo.machine+json", 
          "rel": "machine", 
          "title": "TEST_HYPERVISOR"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/4301", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "location", 
          "title": "73"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555", 
          "type": "application/vnd.abiquo.virtualmachine+json", 
          "rel": "edit", 
          "title": "89"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4300/racks/1184/machines/1275/virtualmachines/1555/action/sendmail", 
          "type": "application/vnd.abiquo.mail+json", 
          "rel": "sendmail", 
          "title": "send mail"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4930", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "51"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4930/users/5099", 
          "type": "application/vnd.abiquo.user+json", 
          "rel": "user", 
          "title": "54 55"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749", 
          "type": "application/vnd.abiquo.virtualdatacenter+json", 
          "rel": "virtualdatacenter", 
          "title": "91"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532", 
          "type": "application/vnd.abiquo.virtualappliance+json", 
          "rel": "virtualappliance", 
          "title": "90"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/metadata", 
          "type": "application/vnd.abiquo.metadata+json", 
          "rel": "metadata", 
          "title": "metadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/network/configurations", 
          "type": "application/vnd.abiquo.virtualmachinenetworkconfigurations+json", 
          "rel": "configurations", 
          "title": "vlan network configurations"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/network/nics", 
          "type": "application/vnd.abiquo.nics+json", 
          "rel": "nics", 
          "title": "nics"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/storage/disks", 
          "type": "application/vnd.abiquo.harddisks+json", 
          "rel": "harddisks", 
          "title": "disks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/state", 
          "type": "application/vnd.abiquo.virtualmachinestate+json", 
          "rel": "state", 
          "title": "NOT_ALLOCATED"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/action/undeploy", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "undeploy", 
          "title": "virtual machine undeploy"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/action/deploy", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "deploy", 
          "title": "virtual machine deploy"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/action/reset", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "reset", 
          "title": "virtual machine reset"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/action/instance", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "instance", 
          "title": "virtual machine snapshot"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/config/rdpaccess", 
          "type": "application/vnd.abiquo.virtualmachineconsole+json", 
          "rel": "rdpaccess", 
          "title": "remote access"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/firewalls", 
          "type": "application/vnd.abiquo.links+json", 
          "rel": "firewalls", 
          "title": "firewalls"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/loadbalancers", 
          "type": "application/vnd.abiquo.loadbalancers+json", 
          "rel": "loadbalancers", 
          "title": "load balancers"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/backup/action/request", 
          "type": "application/vnd.abiquo.ondemandbackup+json", 
          "rel": "requestbackup", 
          "title": "request on demand backup"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/backup/action/restore", 
          "type": "application/vnd.abiquo.restore+json", 
          "rel": "requestrestore", 
          "title": "request a restore of a backup"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/storage/volumes", 
          "type": "application/vnd.abiquo.volumes+json", 
          "rel": "volumes", 
          "title": "volumes"
        }, 
        {
          "length": "3151", 
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/disks/18666", 
          "rel": "disk0", 
          "title": "08a04195-4e92-4d67-b859-7debdc9a3a39", 
          "diskControllerType": "IDE", 
          "type": "application/vnd.abiquo.harddisk+json", 
          "diskLabel": "99"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/4301/datastoretiers/1022", 
          "type": "application/vnd.abiquo.datastoretier+json", 
          "rel": "datastoretier0", 
          "title": "71"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/action/protect", 
          "type": "text/plain", 
          "rel": "protect", 
          "title": "protect"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/action/unprotect", 
          "type": "text/plain", 
          "rel": "unprotect", 
          "title": "unprotect"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/alarms", 
          "type": "application/vnd.abiquo.alarms+json", 
          "rel": "alarms", 
          "title": "alarms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/actionplans", 
          "type": "application/vnd.abiquo.virtualmachineactionplans+json", 
          "rel": "actionplans", 
          "title": "actionplans"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/actionplans", 
          "type": "application/vnd.abiquo.virtualmachineactionplansflat+json", 
          "rel": "actionplansflat", 
          "title": "actionplansflat"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2749/virtualappliances/1532/virtualmachines/1555/action/clone", 
          "type": "application/vnd.abiquo.virtualmachinecloneoptions+json", 
          "rel": "clone", 
          "title": "clone"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/TEST_HYPERVISOR", 
          "type": "application/vnd.abiquo.hypervisortype+json", 
          "rel": "hypervisortype", 
          "title": "TestHypervisor"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4930/datacenterrepositories/4301/virtualmachinetemplates/2003", 
          "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
          "rel": "virtualmachinetemplate", 
          "title": "85"
        }, 
        {
          "href": "http://localhost:9009/api/config/categories/1951", 
          "type": "application/vnd.abiquo.category+json", 
          "rel": "category", 
          "title": "86"
        }
      ], 
      "idType": 0, 
      "variables": {}, 
      "ram": 4, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512487861000, 
      "id": 1555, 
      "uuid": "7edd9eec-b4b4-4ad6-bfff-f15d3475eb79", 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "89", 
      "idState": 1, 
      "vdrpEnabled": true, 
      "state": "NOT_ALLOCATED", 
      "protected": false, 
      "lastSynchronize": 1512487861000, 
      "type": "NOT_MANAGED", 
      "cpu": 1, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }, 
    {
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/4300/racks/1184/machines/1275", 
          "type": "application/vnd.abiquo.machine+json", 
          "rel": "machine", 
          "title": "TEST_HYPERVISOR"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/4301", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "location", 
          "title": "73"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556", 
          "type": "application/vnd.abiquo.virtualmachine+json", 
          "rel": "edit", 
          "title": "VM2"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4300/racks/1184/machines/1275/virtualmachines/1556/action/sendmail", 
          "type": "application/vnd.abiquo.mail+json", 
          "rel": "sendmail", 
          "title": "send mail"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4930", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "51"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4930/users/5099", 
          "type": "application/vnd.abiquo.user+json", 
          "rel": "user", 
          "title": "54 55"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750", 
          "type": "application/vnd.abiquo.virtualdatacenter+json", 
          "rel": "virtualdatacenter", 
          "title": "96"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533", 
          "type": "application/vnd.abiquo.virtualappliance+json", 
          "rel": "virtualappliance", 
          "title": "93"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/metadata", 
          "type": "application/vnd.abiquo.metadata+json", 
          "rel": "metadata", 
          "title": "metadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/network/configurations", 
          "type": "application/vnd.abiquo.virtualmachinenetworkconfigurations+json", 
          "rel": "configurations", 
          "title": "vlan network configurations"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/network/nics", 
          "type": "application/vnd.abiquo.nics+json", 
          "rel": "nics", 
          "title": "nics"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/storage/disks", 
          "type": "application/vnd.abiquo.harddisks+json", 
          "rel": "harddisks", 
          "title": "disks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/state", 
          "type": "application/vnd.abiquo.virtualmachinestate+json", 
          "rel": "state", 
          "title": "ALLOCATED"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/action/undeploy", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "undeploy", 
          "title": "virtual machine undeploy"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/action/deploy", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "deploy", 
          "title": "virtual machine deploy"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/action/reset", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "reset", 
          "title": "virtual machine reset"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/action/instance", 
          "type": "application/vnd.abiquo.acceptedrequest+json", 
          "rel": "instance", 
          "title": "virtual machine snapshot"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/config/rdpaccess", 
          "type": "application/vnd.abiquo.virtualmachineconsole+json", 
          "rel": "rdpaccess", 
          "title": "remote access"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/tasks", 
          "type": "application/vnd.abiquo.tasks+json", 
          "rel": "tasks", 
          "title": "tasks"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/firewalls", 
          "type": "application/vnd.abiquo.links+json", 
          "rel": "firewalls", 
          "title": "firewalls"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/loadbalancers", 
          "type": "application/vnd.abiquo.loadbalancers+json", 
          "rel": "loadbalancers", 
          "title": "load balancers"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/backup/action/request", 
          "type": "application/vnd.abiquo.ondemandbackup+json", 
          "rel": "requestbackup", 
          "title": "request on demand backup"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/backup/action/restore", 
          "type": "application/vnd.abiquo.restore+json", 
          "rel": "requestrestore", 
          "title": "request a restore of a backup"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/storage/volumes", 
          "type": "application/vnd.abiquo.volumes+json", 
          "rel": "volumes", 
          "title": "volumes"
        }, 
        {
          "length": "550", 
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/disks/18667", 
          "rel": "disk0", 
          "title": "fc78300d-33db-4000-85c7-1a6dd5876be5", 
          "diskControllerType": "IDE", 
          "type": "application/vnd.abiquo.harddisk+json", 
          "diskLabel": "101"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/locations/4301/datastoretiers/1022", 
          "type": "application/vnd.abiquo.datastoretier+json", 
          "rel": "datastoretier0", 
          "title": "71"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/action/protect", 
          "type": "text/plain", 
          "rel": "protect", 
          "title": "protect"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/action/unprotect", 
          "type": "text/plain", 
          "rel": "unprotect", 
          "title": "unprotect"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/metrics", 
          "type": "application/vnd.abiquo.metricsmetadata+json", 
          "rel": "metricsmetadata", 
          "title": "metricsmetadata"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/metrics/collectd", 
          "type": "application/json", 
          "rel": "collectd", 
          "title": "collectd"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/alarms", 
          "type": "application/vnd.abiquo.alarms+json", 
          "rel": "alarms", 
          "title": "alarms"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/actionplans", 
          "type": "application/vnd.abiquo.virtualmachineactionplans+json", 
          "rel": "actionplans", 
          "title": "actionplans"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/actionplans", 
          "type": "application/vnd.abiquo.virtualmachineactionplansflat+json", 
          "rel": "actionplansflat", 
          "title": "actionplansflat"
        }, 
        {
          "href": "http://localhost:9009/api/cloud/virtualdatacenters/2750/virtualappliances/1533/virtualmachines/1556/action/clone", 
          "type": "application/vnd.abiquo.virtualmachinecloneoptions+json", 
          "rel": "clone", 
          "title": "clone"
        }, 
        {
          "href": "http://localhost:9009/api/config/hypervisortypes/TEST_HYPERVISOR", 
          "type": "application/vnd.abiquo.hypervisortype+json", 
          "rel": "hypervisortype", 
          "title": "TestHypervisor"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4930/datacenterrepositories/4301/virtualmachinetemplates/2003", 
          "type": "application/vnd.abiquo.virtualmachinetemplate+json", 
          "rel": "virtualmachinetemplate", 
          "title": "85"
        }, 
        {
          "href": "http://localhost:9009/api/config/categories/1951", 
          "type": "application/vnd.abiquo.category+json", 
          "rel": "category", 
          "title": "86"
        }
      ], 
      "idType": 0, 
      "variables": {}, 
      "ram": 4, 
      "highDisponibility": 0, 
      "creationTimestamp": 1512487861000, 
      "id": 1556, 
      "uuid": "72dbc089-dfa9-41e0-8f68-46730d54cf86", 
      "vdrpPort": 0, 
      "backuppolicies": [], 
      "monitored": false, 
      "name": "VM2", 
      "idState": 2, 
      "vdrpEnabled": true, 
      "state": "ALLOCATED", 
      "protected": false, 
      "lastSynchronize": 1512487861000, 
      "type": "MANAGED", 
      "cpu": 1, 
      "generateGuestInitialPassword": false, 
      "metadata": null
    }
  ]
}