[Virtual Machine] getNode

getNode

Process Overview of the Function

Detail information for the specified virtual server is returned.
If the virtual server ID is invalid or does not exist then an error is returned.

Request Parameters

Specify the following parameters when executing this function.

ParameterDescriptionRequired

Identifier

VM identifier

(This parameter has the same meaning as below-mentioned virtual_machine_id and will be discarded after a certain period of time.)

Specify the identifier of a virtual server.
Either one of Identifier or virtual_machine_id parameter is required.
The virtual server identifier can be obtained from the 4.1. listNodes function.

In the 4.1. listNodes function response object, the corresponding field is, identifier.
virtual_machine_id

Virtual Server ID

Specify the ID of a virtual server.
One of either virtual_machine_id parameter or Identifier is required.
The virtual server ID can be obtained from the 4.1. listNodes function.
In the 4.1. listNodes function response object, the corresponding field is, id.

Response Object

The same format as in 4.1. listNode is used in the response.
Refer to the 4.1. listNode Response Object for details.
The following table describes those objects that are not included in 4.1.listNode response.

FieldDescription
backup Returns the size (disk space) of the backup for the specified virtual server.
backups Returns the status of the backup and backup size for the specified virtual server.
(Refer to 6.1. listBackups chapter for details on parameters included in this field.)
backup_size Returns the total value of the size (disk space) of the backups for the specified virtual server.
disks Returns the disk allocated to the specified virtual server and its detail information.
(Refer to 5.1. listDisks chapter for details on parameters included in this field.)
ip Returns the IP address allocated to the specified virtual server.
network_interfaces Returns detail information of the network interfaces allocated to the specified virtual server.
Refer to 7.1. listNetworkInterfaces chapter for details on parameters included in this field.
type

Returns the type of the specified virtual server.

vm : virtual server
LB : load balancer

Request Sample

https://api.gmocloud.com/Cloud-Zone-ID/?Action=getNode&AccessKeyId= AccessKeyId &Version=1.0&Identifier=Id_of_VM&Signature=Signature

Response Sample

{
"cpus": 1,
"label": "VM-Label-example",
"created_at": "2012-07-19T12:32:33+09:00",
"operating_system_distro": "rhel",
"cpu_shares": 1,
"enable_autoscale": false,
"operating_system": "linux",
"template_id": 9,
"allowed_swap": true,
"memory": 128,
"updated_at": "2012-07-20T23:42:51+09:00",
"allow_resize_without_reboot": true,
"recovery_mode": false,
"enable_monitis": false,
"hypervisor_id": Id_of_HV,
"id": Id_of_VM,
"allowed_hot_migrate": true,
"note": NULL,
"suspended": false,
"booted": true,
"hostname": "gmocloud.example.jp",
"template_label": "CentOS 6.0 LAMP x64 xen",
"total_disk_size": 6,
"identifier": "Identifier_of_VM",
"initial_root_password": "Password",
"min_disk_size": 5,
"built": true,
"locked": false,
"state": "on",
"ip_addresses": [
{
"ip_address": {
"address": "192.168.0.100",
"disallowed_primary": false,
"netmask": "255.255.255.0",
"created_at": "2012-06-13T19:59:42+09:00",
"broadcast": "192.168.0.255",
"updated_at": "2012-06-13T19:59:42+09:00",
"network_id": Id_of_Network,
"network_address": "192.168.0.0",
"free": false,
"id": Id_of_IPaddress,
"gateway": "192.168.0.254"
}
}
],
"type": "vm",
"ip": [
"192.168.0.100"
],
"disks": {
"Id_of_disk": {
"created_at": "2012-07-19T12:32:33+09:00",
"add_to_linux_fstab": NULL,
"disk_size": 5,
"updated_at": "2012-07-19T12:32:46+09:00",
"primary": true,
"data_store_id": Id_of_DataStore,
"id": Id_of_disk,
"disk_vm_number": 1,
"is_swap": false,
"mount_point": NULL,
"identifier": "Identifier_of_Disk",
"virtual_machine_id": Id_of_VM,
"has_autobackups": true,
"built": true,
"locked": false
},
}
"backup": [
"210520",
"210540"
],
"backup_size": 421060,
"network_interfaces": {
"Id_of_NetworkInterface": {
"label": "eth0",
"created_at": "2012-07-19T12:32:33+09:00",
"usage": NULL,
"updated_at": "2012-07-20T23:50:59+09:00",
"primary": true,
"id":Id_of_VM,
"usage_month_rolled_at": NULL,
"mac_address": "00:00:00:00:00:00",
"default_firewall_rule": "ACCEPT",
"usage_last_reset_at": NULL,
"rate_limit": 1,
"identifier": "Identifier_of_NetworkInterface ",
"network_join_id": Id_of_Network_join_id,
"virtual_machine_id": Id_of_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