Format

Method	GET
URL	/pools/$POOL_ID
Request contents	Empty
Successful answer	PoolInfo Object
Non-successful answer	ErrorMessage Object
Unexpected error	HTTP 500

PoolInfo Object

Schema

pool_id	String	Pool's unique identifier
description	String	User defined field
priority	String	Pool's priority for asking for Host's resources. 1 being the lowest, 5 the highest
desired_state	String	Desired state. Either "active" or "inactive"
current_state	String	Current state. Either "unknown", "inactive", "active", "stopped", "warning" or "error"
host_list	String Array	List of Hosts associated to this Pool
granularity_vcpus	String	Number of vCPUs to be requested at each batch
granularity_vram	String	Amount (GB) of vRAM to be requested at each batch
required_vcpus	String	Total number of vCPUs to be requested
vcpus_present	String	Total number of vCPUs reserved from one or more Hosts
vcpus_free	String	Number of vCPUs reserved from one or more Hosts that are currently not in use by any Guest
required_vram	String	Amount (GB) of vRAM to be requested
vram_present	String	Amount (GB) of vRAM obtained from one or more Hosts
vram_free	String	Amount (GB) of vRAM obtained from one or more Hosts which is currently not in use by any Guest
resources_hosts	PoolHostInfo Array	List of Hosts from where some resources were reserved by this Pool
resources_guests	PoolGuestInfo Array	List of Guests using resources from this Pool

JSON example

{
    "resources_hosts": [{
        "vcpus_total": "30",
        "vcpus_free": "11",
        "host_id": "flexdev01",
        "vram_total": "60",
        "vram_free": "41"
    }],
    "required_vcpus": "30",
    "priority": "5",
    "desired_state": "active",
    "current_state": "active",
    "vcpus_free": 11,
    "description": "",
    "vcpus_present": 30,
    "granularity_vcpus": "1",
    "granularity_vram": "2",
    "host_list": ["flexdev01"],
    "required_vram": "60",
    "vram_present": 60,
    "resources_guests": [{
        "guest_id": "opensuse421_public-volatile-e30ca1bb",
        "vcpus": "2",
        "vram": "2"
    }, {
        "guest_id": "windowsXP_public-volatile-2fc460a9",
        "vcpus": "1",
        "vram": "1"
    }, {
        "guest_id": "opensuse421_public-volatile-787c3d17",
        "vcpus": "2",
        "vram": "2"
    }, {
        "guest_id": "windows7_020216-volatile-ad817d46",
        "vcpus": "2",
        "vram": "2"
    }, {
        "guest_id": "opensuse421_public-volatile-41b8354a",
        "vcpus": "2",
        "vram": "2"
    }, {
        "guest_id": "windows7_020216-volatile-f8dc52cc",
        "vcpus": "2",
        "vram": "2"
    }, {
        "guest_id": "windows7_020216-volatile-6bf221c9",
        "vcpus": "2",
        "vram": "2"
    }, {
        "guest_id": "windows7_020216-volatile-687d354a",
        "vcpus": "2",
        "vram": "2"
    }, {
        "guest_id": "windows7_020216-volatile-657536a6",
        "vcpus": "2",
        "vram": "2"
    }, {
        "guest_id": "windowsXP_public-volatile-43d4e04c",
        "vcpus": "1",
        "vram": "1"
    }, {
        "guest_id": "windowsXP_public-volatile-19a07939",
        "vcpus": "1",
        "vram": "1"
    }],
    "vram_free": 41,
    "pool_id": "demo_public"
}

PoolHostInfo

Schema

host_id	String	Host's unique identifier
vcpus_total	String	Number of vCPUs lent to this Pool
vcpus_free	String	Number of vCPUs lent to this Pool that are currently not in use
vram_total	String	Amount (GB) of vRAM lent to this Pool
vram_free	String	Amount (GB) of vRAM lent to this Pool which is currently not in use

JSON example

{
    "vcpus_total": "30",
    "vcpus_free": "11",
    "host_id": "flexdev01",
    "vram_total": "60",
    "vram_free": "41"
}

PoolGuestInfo Object

Schema

guest_id	String	Guest's unique identifier
vcpus	String	Number of vCPUs from this Pool in use by this Guest
vram	String	Amount (GB) of vRAM from this Pool in use by this Guest

JSON example

{
    "guest_id": "opensuse421_public-volatile-e30ca1bb",
    "vcpus": "2",
    "vram": "2"
}