Getting full information from a certain Pool

Owned by Sergio L. Pascual (Unlicensed)
Nov 17, 2016
2 min read

Format

MethodGET
URL

/pools/$POOL_ID

Request contentsEmpty
Successful answerPoolInfo Object
Non-successful answerErrorMessage Object
Unexpected errorHTTP 500

PoolInfo Object

Schema

pool_idStringPool's unique identifier
descriptionStringUser defined field
priorityStringPool's priority for asking for Host's resources. 1 being the lowest, 5 the highest
desired_stateStringDesired state. Either "active" or "inactive"
current_stateStringCurrent state. Either "unknown", "inactive", "active", "stopped", "warning" or "error"
host_listString ArrayList of Hosts associated to this Pool
granularity_vcpusStringNumber of vCPUs to be requested at each batch
granularity_vramStringAmount (GB) of vRAM to be requested at each batch
required_vcpusStringTotal number of vCPUs to be requested
vcpus_presentStringTotal number of vCPUs reserved from one or more Hosts
vcpus_freeStringNumber of vCPUs reserved from one or more Hosts that are currently not in use by any Guest
required_vramStringAmount (GB) of vRAM to be requested
vram_presentStringAmount (GB) of vRAM obtained from one or more Hosts
vram_freeStringAmount (GB) of vRAM obtained from one or more Hosts which is currently not in use by any Guest
resources_hostsPoolHostInfo ArrayList of Hosts from where some resources were reserved by this Pool
resources_guestsPoolGuestInfo 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_idStringHost's unique identifier
vcpus_totalStringNumber of vCPUs lent to this Pool
vcpus_freeString

Number of vCPUs lent to this Pool that are currently not in use

vram_totalStringAmount (GB) of vRAM lent to this Pool
vram_freeStringAmount (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_idStringGuest's unique identifier
vcpusStringNumber of vCPUs from this Pool in use by this Guest
vramStringAmount (GB) of vRAM from this Pool in use by this Guest

JSON example

 

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