Project

General

Profile

Actions

Feature #4027

closed

Get compute resource VM information through the API

Added by Ewoud Kohl van Wijngaarden over 10 years ago. Updated about 8 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
-
Category:
API
Target version:
-
Difficulty:
Triaged:
Fixed in Releases:
Found in Releases:

Description

It would make life easier if VM information (power status, memory, CPU cores etc) would be accessible through the API.

One use case would be that VMware only allows a VM start action if the VM is turned off. Calling PUT /api/hosts/:id/power with start on a powered on server will always result in an error. Having the power status allows the API user to make more informed decissions.

Being able to modify, such as increase memory, would be a great addition as well.

Note there used to be the undocumented API, but http://localhost:3000/compute_resources/1/vms.json now results

{"message":"/api/ prefix must now be used to access API URLs, e.g. localhost:3000/apihttp://localhost:3000/compute_resources/1/vms.json"}
(including the duplicate host in git develop @ 07c98cdeaadabdb94e33f1135eb7ce601a1112d5).

Actions #1

Updated by Dominic Cleal about 8 years ago

  • Status changed from New to Resolved

Two APIs are now available for this:

  1. PUT /api/v2/hosts/foo.example.com/power with {"power_action":"status"} to retrieve the current power state
  2. GET /api/v2/hosts/foo.example.com/vm_compute_attributes to retrieve compute attributes such as CPUs, memory etc.
Actions

Also available in: Atom PDF