API Reference List

REST Reference

API REST Reference PDF Version

In addition to this post, there is also a downloadable pdf file available

api_portal_login_btn.jpg

API Reference List

ClassificationSummaryAPI Name
Transaction Log

The last 10 minutes of the transaction log, with a status of 201, of the account’s operation and behavior in the Cloud is retrieved.
The same content is reflected as the virtual server activity log of GMO Cloud Hosting’s cloud console.

listTransactionLogs
The last 10 minutes of the transaction log, with a status of 201, of the account’s operation and behavior in the Cloud is retrieved.
The same content is reflected as the virtual server activity log of GMO Cloud Hosting’s cloud console.
listNodeTransactionLogs
Hypervisors List of detail information for all the hypervisors belonging to the specified Cloud Zone is retrieved. listHypervisors
Detail information for the specified hypervisor is returned.
If the specified hypervisor ID is invalid then an error is returned.
getHypervisor
Virtual Machine List of detail information for all the virtual servers belonging to the specified Cloud Zone is retrieved. listNodes
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.
getNode
The specified virtual server is started. startupNode
The specified virtual server is stopped or shutdown. shutdownNode
The specified virtual server is reset and the virtual server is rebuilt (recreated) from pre-built user template.
The operating state of the virtual server after a rebuild can be specified.
buildNode
The specified virtual server is reset, and the virtual server is rebuilt (recreated) using the template with the same template ID (if user template is used, then user template with the same ID) as the one being used at the time.
The virtual server is in a stopped status after the rebuild.
rebuildNode
The virtual server is rebuilt.
After the virtual server rebuild is completed, the virtual server is started.
deployNode
The specified virtual server is deleted. destroyNode
The settings on the specified virtual server is edited. editNode
The root password of a virtual server is reset.
The system automatically replaces the password with randomly selected alphanumeric character string.
resetPasswordNode
The currently running virtual server is restarted. rebootNode
The virtual server is migrated onto a different physical machine. migrateNode
The resource allocation for the virtual server is changed. resizeNode
Disks List of disks is retrieved.
When the virtual server ID is specified, the list of disks attached to the appropriate virtual server is returned.
In all other cases, the list of disks in the GMO Cloud Hosting system is returned.
listDisks
Detail information for the specified disk is returned. getDisk
Disk is added to the specified virtual server. attachDisk
Specific disk of the specified virtual server is deleted. detachDisk
The disk size and automatic backup setting for the specified disk is edited.
The build for the target disk needs to be complete.
editDisk
The backup of the specified disk is created.
The build for the target disk needs to be complete.
Also, a swap disk cannot be specified as the target disk.
createBackup
Backup The list of backups for a virtual server is returned. If a backup does not exist, a NULL string is returned.
If the specified virtual server ID is invalid or does not exist then an error is returned.
listBackups
Backup is converted into template.
This allows it to be used as template in virtual server deployment.
convertBackup
Network Interfaces List of network interfaces allocated to the specified virtual server is returned.
If the specified virtual server ID is invalid or does not exist then an error is returned.
listNetworkInterfaces
Network interface is added to the specified virtual server. attachNetworkInterface
The specific network interface of the specified virtual server is edited.
In order to activate the settings, rebuildNetwork function needs to be executed.
editNetworkInterface
Network interface is deleted from the specified virtual server. detachNetworkInterface
Network List of available physical networks in the specified Cloud zone is returned. listNetworks
Detail information for the specified network is returned. getNetwork
The specified virtual server network is rebuilt.
Execution of this function is required in order to apply the result of each of the attachNetworkInterface function / editNetworkInterface function / detachNetworkInterface function.
rebuildNetwork
IP Addresses List of IP addresses belonging to the specified network is returned. listIpAddresses
Detail information of the specified IP address belonging to a specific network is returned. getIpAddress
IP address is added to the specified virtual server. addIp
IP address is deleted from the specified virtual server. deleteIp
Firewall rule This function gets a list of all the firewall rules which are set in the virtual server. listFirewalls
Returns detailed information about the specified firewall rules getFirewall
Adds firewall rules on a virtual server.
When there are more than one added firewall rules, the application priority becomes the lowest.
In order to enable the added firewall rules, the rules need to be applied using applyFirewall function described in 10.7.
addFirewall
Edits firewall rules which are set in network interface of a specific server. editFirewall
Deletes a specific firewall settings from the specified virtual server deleteFirewall
Sets the default firewall rule to the interface on the specified virtual server setFirewallDefault
Applies firewall rules on a virtual server applyFirewall
Templates Returns a list of templates listImages
Returns detailed information about the specified template getImage
Deletes the specified user template destroyImage
Data Store Returns a list of data store listDatastores
Load Balancers Returns a list of load balancers consisting a load balance cluster and virtual servers. listClusters
Returns detailed information about the specified load balance cluster. getCluster
Edit the setting of load balance a cluster editCluster
Creates a cluster type load balancer deployClusteringBalancer
Adds a virtual server to a cluster type load balancer addClusteringNode
Removes a virtual server from a cluster type load balancer removeClusteringNode
Deletes cluster type load balancers and auto scale type load balancers destroyCluster
Creates an auto scale type load balancer deployAutoScalingBalancer
Edit the setting of a auto scale type load balancer. editAutoScalingBalancer
Returns a list of load balancers listBalancers
Returns detailed information of the specified load balancer.
Returns an error when the specified load balancer ID is invalid or does not exist.
getBalancer
Shuts down the specified load balancer shutdownBalancer
Starts up the specified load balancer startupBalancer
Reboots the specified load balancer rebootBalancer
Initializes the specified load balancer and rebuilds(recreates) a load balancer using the template with the same ID(When a user template is used, use the user template with the same ID) as one used at that time.
The load balancer is in running status after the rebuilding.
rebuildBalancer
Moves a load balancer to a different physical machine migrateBalancer
Resources Gets detailed information on resource in use getResources
Gets resources and the maximum resources which can be allocated and used on virtual servers and load balancers getLimits
Attached sheet   networkID

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