[Virtual Machine] deployNode

deployNode

Process Overview of the Function

The virtual server is rebuilt.
After the virtual server rebuild is completed, the virtual server is started.

Request Parameters

Specify the following parameter(s) when executing this function.

ParameterDescriptionRequired
template_id

Template ID

Specify the template ID used for virtual server build.
The system template and user template ID can be obtained from the 11.1 listImages function.
In the 11.1 listImages function response object, the corresponding field is, id.

Identifier

Template ID

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

Specify the template ID used for virtual server rebuild.
The system template and user template ID can be obtained from the 11.1 listImages function.
In the 11.1 listImages function response object, the corresponding field is, id.

×
cpu_shares

CPU Share

When Xen is selected for the hypervisor of the virtual server to be built, the virtual CPU share can be optionally specified.
When this parameter is not specified, the initial value is 1.
When KVM is selected for the hypervisor, the value is fixed at 100.

×
cpus

Number of CPU Cores

Specify the number of virtual CPU cores allocated to the virtual server to be built.

data_store_group_primary_id

Disk Datastore ID

Specify the datastore zone ID of the primary disk allocated to the virtual server to be built.
The datastore zone ID can be obtained from the 12.1. listDatastores function.
In the 12.1 listDatastores function response object, the corresponding field is, id.

×
data_store_group_swap_id

Swap Datastore ID

Specify the datastore zone ID of the swap disk allocated to the virtual server to be built.
The datastore zone ID can be obtained from the 12.1. listDatastores function.
In the 12.1 listDatastores function response object, the corresponding field is, id.

×
hostname

Host Name

Specify the hostname of the virtual server to be built.

hypervisor_group_id

Hypervisor Group ID

Specify the hypervisor group ID allocated to the hypervisor building the virtual server.
When hypervisor group ID is not specified, the virtual server will be built in any one of the available hypervisors in GMO Cloud Hosting.

The hypervisor group ID can be obtained from the 3.1 listHypervisors function.
In the 3.1 listHypervisors function response object, the corresponding field is, hypervisor_group_id.

×
hypervisor_id

Hypervisor ID

Specify the ID of the hypervisor building the virtual server.
When hypervisor ID is not specified, the virtual server will be built in the hypervisor selected from all the hypervisors in the GMO Cloud Hosting with the most available memory.
The hypervisor ID can be obtained from the 3.1 listHypervisors function.
In the 3.1 listHypervisors function response object, the corresponding field is, id.

×
initial_root_password

root Password

Specifies the root user’s initial pasword for the virtual server to be built.
Password can use the following character strings.
・ 6 to 32 characters long
・ Single byte upper case alphabet, A to Z
・ Single byte lower case alphabet, a to z.
・ Single byte numeral, 0 to 9
・ – (hyphen), _ (underscore)

When nothing is specified for the initial password character string, GMO Cloud Hosting system will assign a password generated with a random character string.

×
label

Label

Specify the label of the virtual server to be built.
When several virtual servers are to be built, the label is used to easily distinguish them.

memory

Memory [MB]

Specify the memory amount to be allocated to the virtual server to be built.
Unit is in MB (MegaBytes).

note

Memo

Specify the comments that can be attached to the virtual server to be built.

×
primary_disk_size

Disk Size [GB]

Specify the disk size (disk space) of the primary disk of the virtual server to be built.

Unit is in GB (GigaBytes).

primary_network_group_id

Network Group ID

Specify ID of the network group allocated to the virtual server to be built.
The Network Group ID can be obtained from the 8.1 listNetworks function.
In the 8.1 listNetworks function response object, the corresponding field is, network_group_id.

×
primary_network_id

Network ID

Specify the ID of the network allocated to the virtual server to be built.
The Network ID can be obtained from the 8.1. listNetworks function.
In the 8.1 listNetworks function response object, the corresponding field is, id.

×
rate_limit

Bandwidth [Mbps]

Specify the port speed of the network allocated to the virtual server to be built.
Unit is in Mbps.

required_automatic_backup

Automatic Backup Specification

Specify execution of the automatic backup on the virtual server to be built.

1 : Execute automatic backup
2 : Do not execute automatic backup

×
required_virtual_machine_build

Server Build

Specify whether to start the virtual server when it is built.

1 : Build and start the virtual server
0 : Build the virtual server only

×
selected_ip_address_id

IP Address

Specify the IP address to be allocated to the virtual server to be built.

The IP addresses that can be specified can be obtained from the 9.1. listAddresses function.
In the 9.1 listAddresses function response object, the corresponding field is id, in the IP address where the parameter, free, is set to true..

×
swap_disk_size

Swap Disk Size

Specify the disk size (disk space) of the swap disk to be allocated to the virtual server to be built.
Unit is in GB (GigaBytes).
There is no swap disk in case of Windows based OS.

Response Object

The following format is used in the response.

ParameterDescription
Identifier If the request to build the virtual server is successful then the Identifier allocated to the virtual server is returned.

Request Sample

https://api.gmocloud.com/Cloud-Zone-ID/?Action=deployNode&AccessKeyId=AccessKeyId&Version=1.0&template_id=ID_of_Template&cpu_shares=1&cpus=1&data_store_group_primary_id=ID_of_DataStore-Group&data_store_group_swap_id=ID_of_DataStore-Group&hostname=gmocloud.example.com&hypervisor_group_id=ID_of_HV-Group&hypervisor_id=ID_of_HV&initial_root_password=Password&label=VM-Label-example&memory=128&note=memo&primary_disk_size=5&primary_network_group_id=ID_of_Network-Group&primary_network_id=ID_of_Network&rate_limit=1&required_automatic_backup=0&required_virtual_machine_build=0&selected_ip_address_id=ID_of_IPaddress&swap_disk_size=1&Signature=Signature

Response Sample

{
"identifier": "Identifier_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