[Hypervisors] listHypervisors

listHypervisors

Process Overview of the Function

List of detail information for all the hypervisors belonging to the specified Cloud Zone is retrieved.

Request Parameter

There is no parameter to be specified when executing this function.

Response Object

The following format will be used for response, according to the hypervisor type, Xen and KVM.

NameDescription
xen Contains information in the Xen hypervisor format
kvm Contains information in the KVM hypervisor format
cpu_cores Returns the number of CPU cores that hypervisor is using.
created_at

Returns the date and time the hypervisor is created in the GMO Cloud Hosting system.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

data_stores

Returns the Datastore ID and the free space on each datastore that the hypervisor can use.
Datastore belongs to Datastore Group.
The format is as follows, and disk space is in GB (GigaBytes).

“Datastore-ID” : Disk-Available-Size

data_store_group

Returns the Datastore Group ID and the free space on each datastore group that the hypervisor can use.

Free space on Datastore Group is equal to the total free space on datastores belonging to it.
The format is as follows, and disk space is in GB (GigaBytes).

“DataStoreGroup-ID” : Disk-Available-Size

disable_failover

Returns whether the hypervisor can failover or not.

true : Setting does not allow failover.
false : Setting other than the above.

enabled Returns the status on hypervisor availability.

true : Hypervisor is available
false : Status other than the above.
free_memory

In the hypervisor accommodating the virtual server, the free memory not allocated to the virtual server is returned.

Unit is in MB (MegaBytes).

hypervisor_group_id Returns the Hypervisor Group ID allocated to the hypervisor.
hypervisor_type Returns the hypervisor type.
id Returns the hypervisor ID.
label Returns the hypervisor label.
locked

Returns the hypervisor lock status.

true : Hypervisor is locked.
false : Status other than the above.

memory_allocated_by_running_vms

Returns the total amount of hypervisor memory allocated to all the virtual servers accommodated by the hypervisor.

Unit is in MB (MegaBytes).

memory_overhead Returns the net remaining amount of hypervisor memory from the total amount of memory allocated to all the virtual servers accommodated by the hypervisor, subtracted by the total amount of memory allocated to the running virtual servers .
Unit is in MB (MegaBytes).
online Returns the status on hypervisor availability.

true : Hypervisor is available
false : Status other than the above.
total_cpus Returns the number of cores in the physical CPU of the hypervisor.
total_memory Returns the total available amount of memory on the hypervisor.
Unit is in MB (MegaBytes).
total_memory_allocated_by_vms Returns the total amount of memory allocated to all the virtual servers on the hypervisor.
Unit is in MB (MegaBytes).
updated_at

Returns the date and time of last update of the hypervisor.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

used_cpu_resources Returns the utilization percentage of the virtual CPU cores on the hypervisor.
used_memory Returns the sum of the amount of memory allocated to all the virtual servers on the hypervisor and the overhead memory used by the hypervisor.
Unit is in MB (MegaBytes).

Request Sample

https://api.gmocloud.com/Cloud-Zone-ID/?Action=listHypervisors&AccessKeyId=AccessKeyID&Version=1.0&Signature=Signature

Response Sample

{
"xen": {
"ID_of_HV": {
"label": "HV-Label-example",
"created_at": "2012-06-13T18:59:37+09:00",
"hypervisor_type": "xen",
"used_cpu_resources": 2491,
"memory_allocated_by_running_vms": 31088,
"updated_at": "2012-08-14T21:07:19+09:00",
"enabled": true,
"hypervisor_group_id": ID_of_HV-Group,
"id": ID_of_HV,
"total_memory": 147445,
"total_cpus": 24,
"memory_overhead": 4096,
"free_memory": 109189,
"cpu_cores": 12,
"locked": false,
"online": true,
"total_memory_allocated_by_vms": 34160,
"data_stores": {
"5": 39,
"25": 1470,
"1": 60,
"19": 24,
"13": 80,
"9": 80,
"23": 1176
},
"data_store_groups": {
"3": 2929
},
"used_memory": 38256
},
"kvm": {
"ID_of_HV": {
"label": "HV-Label-example",
"created_at": "2012-08-09T12:16:31+09:00",
"hypervisor_type": "kvm",
"used_cpu_resources": 1700,
"memory_allocated_by_running_vms": 35488,
"updated_at": "2012-08-14T21:07:22+09:00",
"enabled": true,
"hypervisor_group_id": ID_of_HV-Group,
"id": ID_of_HV,
"total_memory": 144966,
"total_cpus": 24,
"memory_overhead": 4096,
"free_memory": 105254,
"cpu_cores": 12,
"locked": false,
"online": true,
"total_memory_allocated_by_vms": 35616,
"data_stores": {
"15": 301,
"21": 463,
"17": 258,
"7": 481,
"3": 244,
"11": 344
},
"data_store_groups": {
"3": 2091
},
"used_memory": 39712
},
}
}
}

Note: GMO CLOUD AMERICA INC. does not make any guarantee with regard to the content of this manual and will not be held responsible for any damages resulting from customers or third parties.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk