[Virtual Machine] listNodes

listNodes

Process Overview of the Function

List of detail information for all the virtual servers 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 is used in the response.

FieldDescription
autoscaleout Returns detail information on virtual servers under the control of autoscale type loadbalancer.
cluster Returns detail information on virtual servers under the control of cluster type loadbalancer.
vm Returns detail information on the virtual servers, of all those belonging to the contract account, which are not under the control of either autoscale type or cluster type loadbalancer.
allow_resize_without_reboot

Returns whether each resource size can be altered without restarting the virtual server.

true : Size can be altered without restarting
false : Status other than the above

allowed_hot_migrate Returns whether virtual server can be hot migrated or not (Depends on OS template used in virtual server build.).

true : Hot migration is allowed
false : Status other than the above
allowed_swap Returns whether swap disk can be utilized on the virtual server or not (Depends on OS template used in virtual server build).

true : Swap disk is allowed.
false : Status other than the above
booted Returns the virtual server operating status.

true : Virtual server is running
false : Status other than the above
built Returns the virtual server build status.

true : Built.
false : Status other than the above
cpu_shares Returns the share of the CPU allocated to the virtual server.
cpus Returns the number of virtual CPU cores allocated to the virtual server.
created_at

Returns the date and time the virtual server was created.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

enable_autoscale

Returns the autoscale setting status on the virtual server.

true : Autoscale is set.
false : Status other than the above

enable_monitis

enable_monitisReturns the operating status of the daemon on the virtual server monitoring the autoscale setting status.

true : Active status
false : Status other than the above

hostname

Returns the host name specified in the virtual server.

hypervisor_id

Returns the hypervisor ID that the virtual server is using.

id

Returns the virtual server ID.

identifier

Returns the virtual server identifier.

initial_root_password

Returns the initial root password of the virtual server.

ip

Returns the IP address allocated to the specified virtual server.

ip_addresses

Returns the IP address allocated to the virtual server and the detail information.
Refer to 10.1. listIpAddresses function for details on parameters included in this field.

label

Returns the label assigned to the virtual server.

locked

Returns the lock status of the virtual server.

true : Virtual server is locked.
false : Status other than the above

memory

Returns amount of memory allocated to the virtual server.

Unit is in MB (MegaBytes).

min_disk_size

Returns the minimum disk size required to build the virtual server from the specified template.

note

Returns the registered notice information linked to the user account.

operating_system

Returns the OS type the virtual server is using.

operating_system_distro

Returns the OS distribution type used when virtual server was built.

recovery_mode

Returns the status on whether the virtual server is started with recovery mode or not.

true : Virtual server is started with recovery mode.
false : Status other than the above

state

Returns the status of the virtual server.

on : started
off : stopped
running : processing transactions
pending : waiting to process transactions

suspended

Returns the status of the virtual server whether it is suspended or not.

true : Virtual server is suspended.
false : Status other than the above

template_id

Returns the template ID specified at the time of the virtual server build.

template_label

Returns the template label (name) specified at the time of virtual server build.

total_disk_size

Returns disk space of all the disks allocated to the virtual server.
Unit is in GB (GigaBytes).

type

Returns the type of the specified virtual server.

vm : virtual server

updated_at

Returns the date and time when the virtual server settings are last updated.
Date and time is expressed in the following format.

YYYY-MM-DDThh:mm:ssZ

Request Sample

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

Response Sample

{
"vm": {
"ID_of_VM": {
"cpus": 1,
"label": "VM-Label-example",
"created_at": "2012-08-10T12:37:40+09:00",
"operating_system_distro": "rhel",
"cpu_shares": 1,
"enable_autoscale": false,
"operating_system": "linux",
"template_id": ID_of_Template,
"allowed_swap": true,
"memory": 128,
"updated_at": "2012-08-22T14:17:02+09:00",
"allow_resize_without_reboot": true,
"recovery_mode": NULL,
"enable_monitis": false,
"hypervisor_id": ID_of_Hypervisor,
"id": ID_of_VM,
"allowed_hot_migrate": true,
"note": NULL,
"suspended": false,
"booted": false,
"hostname": "gmocloud1.example.com",
"template_label": "Template-Label-example",
"total_disk_size": 6,
"identifier": "Identifier_of_VM",
"initial_root_password": "Password",
"min_disk_size": 5,
"built": true,
"locked": true,
"state": "locked",
"ip_addresses": {
"ID_of_IpAddress": {
"address": "192.168.0.100",
"disallowed_primary": false,
"netmask": "255.255.255.0",
"created_at": "2012-08-10T09:12:23+09:00",
"broadcast": "192.168.0.255",
"updated_at": "2012-08-10T09:12:23+09:00",
"network_id": ID_of_Network,
"network_address": "192.168.0.0",
"free": false,
"id": ID_of_IpAddress,
"gateway": "192.168.0.254"
}
},
"ip": [
"192.168.0.100"
],
"type": "vm"
}
},
"cluster": {
"ID_of_VM": {
"cpus": 1,
"label": "Template-Label-example",
"created_at": "2012-08-22T12:26:52+09:00",
"operating_system_distro": "rhel",
"cpu_shares": 1,
"enable_autoscale": false,
"operating_system": "linux",
"template_id": ID_of_Template,
"allowed_swap": true,
"memory": 128,
"updated_at": "2012-08-22T14:17:02+09:00",
"allow_resize_without_reboot": true,
"recovery_mode": NULL,
"enable_monitis": false,
"hypervisor_id": ID_of_Hypervisor,
"id": ID_of_VM,
"allowed_hot_migrate": true,
"note": NULL,
"suspended": false,
"booted": true,
"hostname": "gmocloud2.example.jp",
"template_label": "Template-Label-examplen",
"total_disk_size": 6,
"identifier": "Identifier_of_VM",
"initial_root_password": "Password",
"min_disk_size": 5,
"built": true,
"locked": false,
"state": "on",
"ip_addresses": {
"ID_of_IpAddress": {
"address": "192.168.0.101",
"disallowed_primary": false,
"netmask": "255.255.255.0",
"created_at": "2012-08-17T17:29:17+09:00",
"broadcast": "192.168.0.255",
"updated_at": "2012-08-17T17:29:17+09:00",
"network_id": ID_of_Network,
"network_address": "192.168.0.0",
"free": false,
"id": ID_of_IpAddress,
"gateway": "192.168.0.254"
}
},
"ip": [
"192.168.0.101"
],
"type": "vm"
},
"ID_of_VM": {
"cpus": 1,
"label": "VM-Label-example",
"created_at": "2012-08-22T12:28:13+09:00",
"operating_system_distro": "rhel",
"cpu_shares": 1,
"enable_autoscale": false,
"operating_system": "linux",
"template_id": ID_of_Template,
"allowed_swap": true,
"memory": 128,
"updated_at": "2012-08-22T14:17:02+09:00",
"allow_resize_without_reboot": true,
"recovery_mode": NULL,
"enable_monitis": false,
"hypervisor_id": ID_of_Hypervisor,
"id": ID_of_VM,
"allowed_hot_migrate": true,
"note": NULL,
"suspended": false,
"booted": true,
"hostname": "gmocloud3.example.com",
"template_label": "Template-Label-example",
"total_disk_size": 6,
"identifier": "Identifier_of_VM",
"initial_root_password": "Password",
"min_disk_size": 5,
"built": true,
"locked": false,
"state": "on",
"ip_addresses": {
"ID_of_IpAddress": {
"address": "192.168.0.102",
"disallowed_primary": false,
"netmask": "255.255.255.0",
"created_at": "2012-08-17T17:30:35+09:00",
"broadcast": "192.168.0.255",
"updated_at": "2012-08-17T17:30:35+09:00",
"network_id": ID_of_Network,
"network_address": "192.168.0.0",
"free": false,
"id": ID_of_IpAddress,
"gateway": "192.168.0.254"
}
},
"ip": [
"192.168.0.102"
],
"type": "vm"
}
},
"autoscaleout": {
"ID_of_VM": {
"cpus": 1,
"label": "VM-Label-example",
"created_at": "2012-08-22T12:48:27+09:00",
"operating_system_distro": "rhel",
"cpu_shares": 5,
"enable_autoscale": NULL,
"operating_system": "linux",
"template_id": ID_of_Template,
"allowed_swap": true,
"memory": 128,
"updated_at": "2012-08-22T14:17:02+09:00",
"allow_resize_without_reboot": true,
"recovery_mode": NULL,
"enable_monitis": true,
"hypervisor_id": ID_of_Hypervisor,
"id": ID_of_VM,
"allowed_hot_migrate": true,
"note": NULL,
"suspended": false,
"booted": true,
"hostname": "gmocloud4.example.com",
"template_label": "Template-Label-example",
"total_disk_size": 6,
"identifier": "Identifier_of_VM",
"initial_root_password": "Password",
"min_disk_size": 5,
"built": true,
"locked": false,
"state": "on",
"ip_addresses": {
"ID_of_IpAddress": {
"address": "192.168.0.103",
"disallowed_primary": false,
"netmask": "255.255.255.0",
"created_at": "2012-08-17T17:30:35+09:00",
"broadcast": "192.168.0.255",
"updated_at": "2012-08-17T17:30:35+09:00",
"network_id": ID_of_Network,
"network_address": "192.168.0.0",
"free": false,
"id": ID_of_IpAddress,
"gateway": "192.168.0.254"
}
},
"ip": [
"192.168.0.103"
],
"type": "vm"
}
}
}

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