Appearance
CloudStack API Documentatie
Authenticatie & Toegang
login
Logt in met gebruikersnaam en wachtwoord en retourneert een sessiesleutel.
Parameters:
username(string)password(string)- Response Type:
json
{
"loginresponse": {
"timeout": "integer",
"firstname": "string",
"lastname": "string",
"username": "string",
"account": "string",
"type": "integer",
"userid": "uuid (string)",
"domainid": "uuid (string)",
"sessionkey": "base64-encoded string",
"timezone": "string",
"timezoneoffset": "string"
}
}logout
Sluit de huidige sessie af.
Parameters:
sessionkey(string)- Response Type:
json
{
"logoutresponse": {
"description": "string"
}
}API-key login
Alternatieve authenticatievorm zonder sessies, ideaal voor automatisering.
Parameters:
command(string)apiKey(string)signature(string)- Response Type:
json
{
"loginresponse": {
"timeout": integer,
"firstname": "string",
"lastname": "string",
"username": "string",
"account": "string",
"type": integer,
"userid": "uuid (string)",
"domainid": "uuid (string)",
"sessionkey": "base64-encoded string",
"timezone": "string",
"timezoneoffset": "string"
}
}Virtuele Machines
deployVirtualMachine
Maakt een nieuwe virtuele machine aan.
Parameters:
serviceofferingid(string)templateid(string)zoneid(string)networkids(string)name(string, optioneel)displayname(string, optioneel)keypair(string, optioneel)userdata(string, optioneel)- Response Type:
json
{
"deployvirtualmachineresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"displayname": "string",
"name": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"templateid": "uuid (string)",
"templatename": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpu": integer,
"cpuspeed": integer,
"memory": integer,
"nic": [
{
"id": "uuid (string)",
"networkid": "uuid (string)",
"networkname": "string",
"ipaddress": "string",
"isdefault": boolean,
"macaddress": "string",
"gateway": "string",
"netmask": "string",
"traffictype": "string",
"type": "string"
}
],
"hypervisor": "string",
"state": "string",
"haenable": boolean,
"guestosid": "uuid (string)",
"rootdeviceid": integer,
"rootdevicetype": "string",
"passwordenabled": boolean,
"affinitygroup": [
{
"id": "uuid (string)",
"name": "string",
"type": "string"
}
],
"securitygroup": [
{
"id": "uuid (string)",
"name": "string",
"description": "string"
}
]
}
}listVirtualMachines
Toont alle virtuele machines in een account of project.
Parameters:
id(string, optioneel)name(string, optioneel)state(string, optioneel)zoneid(string, optioneel)- Response Type:
json
{
"listvirtualmachinesresponse": {
"count": integer,
"virtualmachine": [
{
"id": "uuid (string)",
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"state": "string",
"haenable": boolean,
"zoneid": "uuid (string)",
"zonename": "string",
"templateid": "uuid (string)",
"templatename": "string",
"templatedisplaytext": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpu": integer,
"cpuspeed": integer,
"memory": integer,
"guestosid": "uuid (string)",
"rootdeviceid": integer,
"rootdevicetype": "string",
"passwordenabled": boolean,
"nic": [
{
"id": "uuid (string)",
"networkid": "uuid (string)",
"networkname": "string",
"ipaddress": "string",
"isdefault": boolean,
"macaddress": "string",
"gateway": "string",
"netmask": "string",
"traffictype": "string",
"type": "string"
}
],
"securitygroup": [
{
"id": "uuid (string)",
"name": "string",
"description": "string"
}
],
"affinitygroup": [
{
"id": "uuid (string)",
"name": "string",
"type": "string"
}
],
"hypervisor": "string",
"hostid": "uuid (string)",
"hostname": "string"
}
]
}
}startVirtualMachine
Start een virtuele machine.
Parameters:
id(string)- Response Type:
json
{
"startvirtualmachineresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"displayname": "string",
"name": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"templateid": "uuid (string)",
"templatename": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpu": integer,
"cpuspeed": integer,
"memory": integer,
"guestosid": "uuid (string)",
"rootdeviceid": integer,
"rootdevicetype": "string",
"passwordenabled": boolean,
"state": "string",
"haenable": boolean,
"hypervisor": "string",
"nic": [
{
"id": "uuid (string)",
"networkid": "uuid (string)",
"networkname": "string",
"ipaddress": "string",
"isdefault": boolean,
"macaddress": "string",
"gateway": "string",
"netmask": "string",
"traffictype": "string",
"type": "string"
}
],
"securitygroup": [
{
"id": "uuid (string)",
"name": "string",
"description": "string"
}
],
"affinitygroup": [
{
"id": "uuid (string)",
"name": "string",
"type": "string"
}
],
"hostid": "uuid (string)",
"hostname": "string"
}
}stopVirtualMachine
Stopt een virtuele machine.
Parameters:
id(string)- Response Type:
json
{
"stopvirtualmachineresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"displayname": "string",
"name": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"templateid": "uuid (string)",
"templatename": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpu": integer,
"cpuspeed": integer,
"memory": integer,
"guestosid": "uuid (string)",
"rootdeviceid": integer,
"rootdevicetype": "string",
"passwordenabled": boolean,
"state": "string",
"haenable": boolean,
"hypervisor": "string",
"nic": [
{
"id": "uuid (string)",
"networkid": "uuid (string)",
"networkname": "string",
"ipaddress": "string",
"isdefault": boolean,
"macaddress": "string",
"gateway": "string",
"netmask": "string",
"traffictype": "string",
"type": "string"
}
],
"securitygroup": [
{
"id": "uuid (string)",
"name": "string",
"description": "string"
}
],
"affinitygroup": [
{
"id": "uuid (string)",
"name": "string",
"type": "string"
}
],
"hostid": "uuid (string)",
"hostname": "string"
}
}rebootVirtualMachine
Herstart een virtuele machine.
Parameters:
id(string)- Response Type:
json
{
"rebootvirtualmachineresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"displayname": "string",
"name": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"templateid": "uuid (string)",
"templatename": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpu": integer,
"cpuspeed": integer,
"memory": integer,
"guestosid": "uuid (string)",
"rootdeviceid": integer,
"rootdevicetype": "string",
"passwordenabled": boolean,
"state": "string",
"haenable": boolean,
"hypervisor": "string",
"nic": [
{
"id": "uuid (string)",
"networkid": "uuid (string)",
"networkname": "string",
"ipaddress": "string",
"isdefault": boolean,
"macaddress": "string",
"gateway": "string",
"netmask": "string",
"traffictype": "string",
"type": "string"
}
],
"securitygroup": [
{
"id": "uuid (string)",
"name": "string",
"description": "string"
}
],
"affinitygroup": [
{
"id": "uuid (string)",
"name": "string",
"type": "string"
}
],
"hostid": "uuid (string)",
"hostname": "string"
}
}destroyVirtualMachine
Verwijdert een virtuele machine.
Parameters:
id(string)expunge(boolean, optioneel)- Response Type:
json
{
"destroyvirtualmachineresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"displayname": "string",
"name": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"templateid": "uuid (string)",
"templatename": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpu": integer,
"cpuspeed": integer,
"memory": integer,
"guestosid": "uuid (string)",
"rootdeviceid": integer,
"rootdevicetype": "string",
"passwordenabled": boolean,
"state": "string",
"haenable": boolean,
"hypervisor": "string",
"nic": [
{
"id": "uuid (string)",
"networkid": "uuid (string)",
"networkname": "string",
"ipaddress": "string",
"isdefault": boolean,
"macaddress": "string",
"gateway": "string",
"netmask": "string",
"traffictype": "string",
"type": "string"
}
],
"securitygroup": [
{
"id": "uuid (string)",
"name": "string",
"description": "string"
}
],
"affinitygroup": [
{
"id": "uuid (string)",
"name": "string",
"type": "string"
}
],
"expunged": boolean,
"hostid": "uuid (string)",
"hostname": "string"
}
}resetPasswordForVirtualMachine
Reset het root-wachtwoord van een VM.
Parameters:
id(string)- Response Type:
json
{
"resetpasswordforvirtualmachineresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"displayname": "string",
"name": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"templateid": "uuid (string)",
"templatename": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpu": integer,
"cpuspeed": integer,
"memory": integer,
"guestosid": "uuid (string)",
"rootdeviceid": integer,
"rootdevicetype": "string",
"passwordenabled": boolean,
"password": "string",
"state": "string",
"haenable": boolean,
"hypervisor": "string",
"nic": [
{
"id": "uuid (string)",
"networkid": "uuid (string)",
"networkname": "string",
"ipaddress": "string",
"isdefault": boolean,
"macaddress": "string",
"gateway": "string",
"netmask": "string",
"traffictype": "string",
"type": "string"
}
],
"securitygroup": [
{
"id": "uuid (string)",
"name": "string",
"description": "string"
}
],
"affinitygroup": [
{
"id": "uuid (string)",
"name": "string",
"type": "string"
}
],
"hostid": "uuid (string)",
"hostname": "string"
}
}updateVirtualMachine
Wijzigt eigenschappen van een bestaande VM.
Parameters:
id(string)displayname(string, optioneel)group(string, optioneel)ostypeid(string, optioneel)- Response Type: {
"updatevirtualmachineresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"displayname": "string",
"name": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"templateid": "uuid (string)",
"templatename": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpu": integer,
"cpuspeed": integer,
"memory": integer,
"guestosid": "uuid (string)",
"rootdeviceid": integer,
"rootdevicetype": "string",
"passwordenabled": boolean,
"state": "string",
"haenable": boolean,
"hypervisor": "string",
"nic": [ { "id": "uuid (string)", "networkid": "uuid (string)", "networkname": "string", "ipaddress": "string", "isdefault": boolean, "macaddress": "string", "gateway": "string", "netmask": "string", "traffictype": "string", "type": "string" } ],
"securitygroup": [ { "id": "uuid (string)", "name": "string", "description": "string" } ],
"affinitygroup": [ { "id": "uuid (string)", "name": "string", "type": "string" } ],
"hostid": "uuid (string)",
"hostname": "string"
}
}
listServiceOfferings
Lijst beschikbare CPU/RAM-profielen voor nieuwe VM's.
Parameters:
id(string, optioneel)- Response Type:
json
{
"listserviceofferingsresponse": {
"count": integer,
"serviceoffering": [
{
"id": "uuid (string)",
"name": "string",
"displaytext": "string",
"cpunumber": integer,
"cpuspeed": integer,
"memory": integer,
"created": "string (ISO 8601 datetime)",
"domain": "string",
"domainid": "uuid (string)",
"issystem": boolean,
"defaultuse": boolean,
"tags": "string",
"serviceofferingdetails": {
"key": "string",
"value": "string"
},
"hosttags": "string",
"iscustomized": boolean,
"iscustomizediops": boolean,
"bytesreadrate": integer,
"byteswriterate": integer,
"iopsreadrate": integer,
"iopswriterate": integer,
"offerha": boolean,
"deploymentplanner": "string",
"volumedetails": {
"key": "string",
"value": "string"
}
}
]
}
}listTemplates
Toont OS-templates.
Parameters:
templatefilter(string)id(string, optioneel)- Response Type:
json
{
"listtemplatesresponse": {
"count": integer,
"template": [
{
"id": "uuid (string)",
"name": "string",
"displaytext": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"ostypeid": "uuid (string)",
"ostypename": "string",
"ispublic": boolean,
"isready": boolean,
"passwordenabled": boolean,
"isextractable": boolean,
"crosszones": boolean,
"format": "string",
"hypervisor": "string",
"templatetype": "string",
"bits": integer,
"size": integer,
"guestosid": "uuid (string)",
"checksum": "string",
"featured": boolean,
"ostypename": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"status": "string",
"bootable": boolean,
"details": {
"key": "string",
"value": "string"
}
}
]
}
}Storage & Volumes
createVolume
Maakt een nieuw opslagvolume aan.
Parameters:
name(string)zoneid(string)diskofferingid(string)Response Type:
json
{
"createvolumeresponse": {
"id": "uuid (string)",
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"diskofferingid": "uuid (string)",
"diskofferingname": "string",
"size": integer,
"state": "string",
"type": "string",
"virtualmachineid": "uuid (string)",
"vmname": "string",
"hypervisor": "string",
"storagetype": "string",
"isextractable": boolean,
"iscustomized": boolean,
"attached": boolean,
"deviceid": integer,
"path": "string"
}
}attachVolume
Koppelt een volume aan een VM.
Parameters:
id(string)virtualmachineid(string)- Response Type:
json
{
"attachvolumeresponse": {
"id": "uuid (string)",
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"diskofferingid": "uuid (string)",
"diskofferingname": "string",
"size": integer,
"state": "string",
"type": "string",
"virtualmachineid": "uuid (string)",
"vmname": "string",
"hypervisor": "string",
"storagetype": "string",
"isextractable": boolean,
"iscustomized": boolean,
"attached": boolean,
"deviceid": integer,
"path": "string"
}
}detachVolume
Ontkoppelt een volume van een VM.
Parameters:
id(string)- Response Type:
json
{
"detachvolumeresponse": {
"id": "uuid (string)",
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"diskofferingid": "uuid (string)",
"diskofferingname": "string",
"size": integer,
"state": "string",
"type": "string",
"virtualmachineid": "uuid (string)",
"vmname": "string",
"hypervisor": "string",
"storagetype": "string",
"isextractable": boolean,
"iscustomized": boolean,
"attached": boolean,
"deviceid": integer,
"path": "string"
}
}deleteVolume
Verwijdert een volume.
Parameters:
id(string)- Response Type:
json
{
"deletevolumeresponse": {
"id": "uuid (string)",
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"diskofferingid": "uuid (string)",
"diskofferingname": "string",
"size": integer,
"state": "string",
"type": "string",
"virtualmachineid": "uuid (string)",
"vmname": "string",
"hypervisor": "string",
"storagetype": "string",
"isextractable": boolean,
"iscustomized": boolean,
"attached": boolean,
"deviceid": integer,
"path": "string",
"expunged": boolean
}
}listVolumes
Lijst van alle volumes.
Parameters:
id(string, optioneel)virtualmachineid(string, optioneel)type(string, optioneel)- Response Type:
json
{
"listvolumesresponse": {
"count": integer,
"volume": [
{
"id": "uuid (string)",
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"zoneid": "uuid (string)",
"zonename": "string",
"diskofferingid": "uuid (string)",
"diskofferingname": "string",
"size": integer,
"state": "string",
"type": "string",
"virtualmachineid": "uuid (string)",
"vmname": "string",
"hypervisor": "string",
"storagetype": "string",
"isextractable": boolean,
"iscustomized": boolean,
"attached": boolean,
"deviceid": integer,
"path": "string"
}
]
}
}createSnapshot
Maakt een snapshot van een volume.
Parameters:
volumeid(string)- Response Type:
json
{
"createsnapshotresponse": {
"id": "uuid (string)",
"name": "string",
"volumeid": "uuid (string)",
"volumename": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"state": "string",
"snapshottype": "string",
"intervaltype": "string",
"revertable": boolean,
"quiesced": boolean,
"hypervisor": "string",
"zonename": "string",
"zoneid": "uuid (string)"
}
}deleteSnapshot
Verwijdert een snapshot.
Parameters:
id(string)- Response Type:
json
{
"deletesnapshotresponse": {
"id": "uuid (string)",
"name": "string",
"volumeid": "uuid (string)",
"volumename": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"state": "string",
"snapshottype": "string",
"intervaltype": "string",
"revertable": boolean,
"quiesced": boolean,
"hypervisor": "string",
"zonename": "string",
"zoneid": "uuid (string)",
"expunged": boolean
}
}listSnapshots
Geeft een overzicht van snapshots.
Parameters:
id(string, optioneel)volumeid(string, optioneel)- Response Type:
json
{
"listsnapshotsresponse": {
"count": integer,
"snapshot": [
{
"id": "uuid (string)",
"name": "string",
"volumeid": "uuid (string)",
"volumename": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"created": "string (ISO 8601 datetime)",
"state": "string",
"snapshottype": "string",
"intervaltype": "string",
"revertable": boolean,
"quiesced": boolean,
"hypervisor": "string",
"zonename": "string",
"zoneid": "uuid (string)",
"expunged": boolean
}
]
}
}Netwerken & IP-beheer
createNetwork
Maak een nieuw virtueel netwerk aan.
Parameters:
name(string)displaytext(string)networkofferingid(string)zoneid(string)acltype(string, optioneel)vpcid(string, optioneel)- Response Type:
json
{
"createnetworkresponse": {
"id": "uuid (string)",
"name": "string",
"displaytext": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"broadcastdomaintype": "string",
"networkofferingid": "uuid (string)",
"networkofferingname": "string",
"traffictype": "string",
"gateway": "string",
"netmask": "string",
"vlan": "string",
"broadcasturi": "string",
"type": "string",
"ispersistent": boolean,
"isdefault": boolean,
"restartrequired": boolean,
"specifyipranges": boolean,
"service": [
{
"name": "string",
"capability": [
{
"name": "string",
"value": "string"
}
]
}
],
"acltype": "string",
"subdomainaccess": boolean,
"physicalnetworkid": "uuid (string)",
"domainrouter": [
{
"id": "uuid (string)",
"name": "string",
"state": "string",
"zoneid": "uuid (string)"
}
]
}
}updateNetwork
Wijzig eigenschappen van een bestaand netwerk.
Parameters:
id(string)name(string, optioneel)displaytext(string, optioneel)changecidr(boolean, optioneel)- Response Type:
json
{
"updatenetworkresponse": {
"id": "uuid (string)",
"name": "string",
"displaytext": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"broadcastdomaintype": "string",
"networkofferingid": "uuid (string)",
"networkofferingname": "string",
"traffictype": "string",
"gateway": "string",
"netmask": "string",
"vlan": "string",
"broadcasturi": "string",
"type": "string",
"ispersistent": boolean,
"isdefault": boolean,
"restartrequired": boolean,
"specifyipranges": boolean,
"service": [
{
"name": "string",
"capability": [
{
"name": "string",
"value": "string"
}
]
}
],
"acltype": "string",
"subdomainaccess": boolean,
"physicalnetworkid": "uuid (string)",
"domainrouter": [
{
"id": "uuid (string)",
"name": "string",
"state": "string",
"zoneid": "uuid (string)"
}
]
}
}deleteNetwork
Verwijder een netwerk.
Parameters:
id(string)- Response Type:
json
{
"deletenetworkresponse": {
"id": "uuid (string)",
"name": "string",
"displaytext": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"broadcastdomaintype": "string",
"networkofferingid": "uuid (string)",
"networkofferingname": "string",
"traffictype": "string",
"gateway": "string",
"netmask": "string",
"vlan": "string",
"broadcasturi": "string",
"type": "string",
"ispersistent": boolean,
"isdefault": boolean,
"restartrequired": boolean,
"specifyipranges": boolean,
"service": [
{
"name": "string",
"capability": [
{
"name": "string",
"value": "string"
}
]
}
],
"acltype": "string",
"subdomainaccess": boolean,
"physicalnetworkid": "uuid (string)",
"domainrouter": [
{
"id": "uuid (string)",
"name": "string",
"state": "string",
"zoneid": "uuid (string)"
}
],
"removed": boolean
}
}listNetworks
Lijst alle netwerken.
Parameters:
zoneid(string, optioneel)trafficType(string, optioneel)account(string, optioneel)domainid(string, optioneel)- Response Type:
json
{
"listnetworksresponse": {
"count": integer,
"network": [
{
"id": "uuid (string)",
"name": "string",
"displaytext": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"broadcastdomaintype": "string",
"networkofferingid": "uuid (string)",
"networkofferingname": "string",
"traffictype": "string",
"gateway": "string",
"netmask": "string",
"vlan": "string",
"broadcasturi": "string",
"type": "string",
"ispersistent": boolean,
"isdefault": boolean,
"restartrequired": boolean,
"specifyipranges": boolean,
"service": [
{
"name": "string",
"capability": [
{
"name": "string",
"value": "string"
}
]
}
],
"acltype": "string",
"subdomainaccess": boolean,
"physicalnetworkid": "uuid (string)",
"domainrouter": [
{
"id": "uuid (string)",
"name": "string",
"state": "string",
"zoneid": "uuid (string)"
}
]
}
]
}
}restartNetwork
Herstart netwerk en router.
Parameters:
id(string)cleanup(boolean, optioneel)- Response Type:
json
{
"restartnetworkresponse": {
"id": "uuid (string)",
"name": "string",
"displaytext": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"broadcastdomaintype": "string",
"networkofferingid": "uuid (string)",
"networkofferingname": "string",
"traffictype": "string",
"gateway": "string",
"netmask": "string",
"vlan": "string",
"broadcasturi": "string",
"type": "string",
"ispersistent": boolean,
"isdefault": boolean,
"restartrequired": boolean,
"specifyipranges": boolean,
"service": [
{
"name": "string",
"capability": [
{
"name": "string",
"value": "string"
}
]
}
],
"acltype": "string",
"subdomainaccess": boolean,
"physicalnetworkid": "uuid (string)",
"domainrouter": [
{
"id": "uuid (string)",
"name": "string",
"state": "string",
"zoneid": "uuid (string)"
}
],
"restart": boolean
}
}listRouters
Toon alle virtuele routers.
Parameters:
zoneid(string, optioneel)networkid(string, optioneel)account(string, optioneel)- Response Type:
json
{
"listroutersresponse": {
"count": integer,
"router": [
{
"id": "uuid (string)",
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"isredundantrouter": boolean,
"redundantrouterid": "uuid (string)",
"guestipaddress": "string",
"linklocalip": "string",
"publicip": "string",
"publicipid": "uuid (string)",
"networkdomain": "string",
"networkid": "uuid (string)",
"gateway": "string",
"netmask": "string",
"templateid": "uuid (string)",
"templatename": "string",
"templateversion": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpunumber": integer,
"cpuspeed": integer,
"memory": integer,
"hypervisor": "string",
"created": "string (ISO 8601 datetime)",
"haenable": boolean,
"project": "string",
"projectid": "uuid (string)"
}
]
}
}startRouter
Start router.
Parameters:
id(string)- Response Type:
json
{
"startrouterresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"isredundantrouter": boolean,
"redundantrouterid": "uuid (string)",
"guestipaddress": "string",
"linklocalip": "string",
"publicip": "string",
"publicipid": "uuid (string)",
"networkdomain": "string",
"networkid": "uuid (string)",
"gateway": "string",
"netmask": "string",
"templateid": "uuid (string)",
"templatename": "string",
"templateversion": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpunumber": integer,
"cpuspeed": integer,
"memory": integer,
"hypervisor": "string",
"created": "string (ISO 8601 datetime)",
"haenable": boolean,
"project": "string",
"projectid": "uuid (string)"
}
}stopRouter
Stop router.
Parameters:
id(string)forced(boolean, optioneel)- Response Type:
json
{
"stoprouterresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"isredundantrouter": boolean,
"redundantrouterid": "uuid (string)",
"guestipaddress": "string",
"linklocalip": "string",
"publicip": "string",
"publicipid": "uuid (string)",
"networkdomain": "string",
"networkid": "uuid (string)",
"gateway": "string",
"netmask": "string",
"templateid": "uuid (string)",
"templatename": "string",
"templateversion": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpunumber": integer,
"cpuspeed": integer,
"memory": integer,
"hypervisor": "string",
"created": "string (ISO 8601 datetime)",
"haenable": boolean,
"project": "string",
"projectid": "uuid (string)"
}
}rebootRouter
Herstart router.
Parameters:
id(string)- Response Type:
json
{
"rebootrouterresponse": {
"id": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"name": "string",
"displayname": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"state": "string",
"isredundantrouter": boolean,
"redundantrouterid": "uuid (string)",
"guestipaddress": "string",
"linklocalip": "string",
"publicip": "string",
"publicipid": "uuid (string)",
"networkdomain": "string",
"networkid": "uuid (string)",
"gateway": "string",
"netmask": "string",
"templateid": "uuid (string)",
"templatename": "string",
"templateversion": "string",
"serviceofferingid": "uuid (string)",
"serviceofferingname": "string",
"cpunumber": integer,
"cpuspeed": integer,
"memory": integer,
"hypervisor": "string",
"created": "string (ISO 8601 datetime)",
"haenable": boolean,
"project": "string",
"projectid": "uuid (string)"
}
}associateIpAddress
Wijs publiek IP toe.
Parameters:
zoneid(string)networkid(string, optioneel)vpcid(string, optioneel)- Response Type:
json
{
"associateipaddressresponse": {
"id": "uuid (string)",
"ipaddress": "string",
"associatednetworkid": "uuid (string)",
"issourcenat": boolean,
"allocated": "string (ISO 8601 datetime)",
"state": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"forvirtualnetwork": boolean,
"issystem": boolean,
"networkid": "uuid (string)",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"project": "string",
"projectid": "uuid (string)"
}
}disassociateIpAddress
Ontkoppel publiek IP.
Parameters:
id(string)- Response Type:
json
{
"disassociateipaddressresponse": {
"id": "uuid (string)",
"ipaddress": "string",
"associatednetworkid": "uuid (string)",
"issourcenat": boolean,
"allocated": "string (ISO 8601 datetime)",
"state": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"forvirtualnetwork": boolean,
"issystem": boolean,
"networkid": "uuid (string)",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"project": "string",
"projectid": "uuid (string)",
"disassociated": boolean
}
}listPublicIpAddresses
Lijst publieke IP's.
Parameters:
account(string, optioneel)domainid(string, optioneel)associatednetworkid(string, optioneel)- Response Type:
json
{
"listpublicipaddressesresponse": {
"count": integer,
"publicipaddress": [
{
"id": "uuid (string)",
"ipaddress": "string",
"associatednetworkid": "uuid (string)",
"issourcenat": boolean,
"allocated": "string (ISO 8601 datetime)",
"state": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"forvirtualnetwork": boolean,
"issystem": boolean,
"networkid": "uuid (string)",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"project": "string",
"projectid": "uuid (string)"
}
]
}
}createPortForwardingRule
Maak port forwarding.
Parameters:
ipaddressid(string)privateport(integer)publicport(integer)protocol(string)virtualmachineid(string)- Response Type:
json
{
"createportforwardingruleresponse": {
"id": "uuid (string)",
"privateport": integer,
"publicport": integer,
"protocol": "string",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"publicipid": "uuid (string)",
"publicip": "string",
"state": "string",
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"networkid": "uuid (string)",
"project": "string",
"projectid": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer
}
}deletePortForwardingRule
Verwijder port forwarding.
Parameters:
id(string)- Response Type:
json
{
"deleteportforwardingruleresponse": {
"id": "uuid (string)",
"privateport": integer,
"publicport": integer,
"protocol": "string",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"publicipid": "uuid (string)",
"publicip": "string",
"state": "string",
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"networkid": "uuid (string)",
"project": "string",
"projectid": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"deleted": boolean
}
}listPortForwardingRules
Lijst port forwarding.
Parameters:
id(string, optioneel)ipaddressid(string, optioneel)- Response Type:
json
{
"listportforwardingrulesresponse": {
"count": integer,
"portforwardingrule": [
{
"id": "uuid (string)",
"privateport": integer,
"publicport": integer,
"protocol": "string",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"publicipid": "uuid (string)",
"publicip": "string",
"state": "string",
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"networkid": "uuid (string)",
"project": "string",
"projectid": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer
}
]
}
}createFirewallRule
Maak firewallregel.
Parameters:
ipaddressid(string)protocol(string)startport(integer)endport(integer)- Response Type:
json
{
"createfirewallruleresponse": {
"id": "uuid (string)",
"protocol": "string",
"startport": integer,
"endport": integer,
"cidrlist": "string",
"networkid": "uuid (string)",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"ipaddressid": "uuid (string)",
"ipaddress": "string",
"state": "string",
"jobid": "uuid (string)",
"jobstatus": integer
}
}listFirewallRules
Lijst firewallregels.
Parameters:
ipaddressid(string, optioneel)- Response Type:
json
{
"listfirewallrulesresponse": {
"count": integer,
"firewallrule": [
{
"id": "uuid (string)",
"protocol": "string",
"startport": integer,
"endport": integer,
"cidrlist": "string",
"networkid": "uuid (string)",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"ipaddressid": "uuid (string)",
"ipaddress": "string",
"state": "string",
"jobid": "uuid (string)",
"jobstatus": integer
}
]
}
}Security Groups
createSecurityGroup
Maak security group.
Parameters:
name(string)description(string)- Response Type:
json
{
"createsecuritygroupresponse": {
"id": "uuid (string)",
"name": "string",
"description": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer
}
}deleteSecurityGroup
Verwijder security group.
Parameters:
nameofid(string)- Response Type:
json
{
"deletesecuritygroupresponse": {
"id": "uuid (string)",
"name": "string",
"description": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"jobid": "uuid (string)",
"jobstatus": integer,
"deleted": boolean
}
}listSecurityGroups
Lijst security groups.
Parameters:
account(string, optioneel)domainid(string, optioneel)- Response Type:
json
{
"listsecuritygroupsresponse": {
"count": integer,
"securitygroup": [
{
"id": "uuid (string)",
"name": "string",
"description": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"ingressrule": [
{
"id": "uuid (string)",
"protocol": "string",
"startport": integer,
"endport": integer,
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"securitygroupname": "string"
}
],
"egressrule": [
{
"id": "uuid (string)",
"protocol": "string",
"startport": integer,
"endport": integer,
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"securitygroupname": "string"
}
]
}
]
}
}authorizeSecurityGroupIngress
Voeg inkomende regel toe.
Parameters:
securitygroupid(string)protocol(string)startport(integer)endport(integer)cidrlist(string)- Response Type:
json
{
"authorizesecuritygroupingressresponse": {
"id": "uuid (string)",
"protocol": "string",
"startport": integer,
"endport": integer,
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"securitygroupname": "string",
"jobid": "uuid (string)",
"jobstatus": integer
}
}authorizeSecurityGroupEgress
Voeg uitgaande regel toe.
Parameters:
securitygroupid(string)protocol(string)startport(integer)endport(integer)cidrlist(string)- Response Type:
json
{
"authorizesecuritygroupegressresponse": {
"id": "uuid (string)",
"protocol": "string",
"startport": integer,
"endport": integer,
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"securitygroupname": "string",
"jobid": "uuid (string)",
"jobstatus": integer
}
}revokeSecurityGroupIngress
Verwijder inkomende regel.
Parameters:
id(string)- Response Type:
json
{
"revokesecuritygroupingressresponse": {
"id": "uuid (string)",
"protocol": "string",
"startport": integer,
"endport": integer,
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"securitygroupname": "string",
"jobid": "uuid (string)",
"jobstatus": integer,
"revoked": boolean
}
}revokeSecurityGroupEgress
Verwijder uitgaande regel.
Parameters:
id(string)- Response Type:
json
{
"revokesecuritygroupegressresponse": {
"id": "uuid (string)",
"protocol": "string",
"startport": integer,
"endport": integer,
"cidrlist": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"securitygroupname": "string",
"jobid": "uuid (string)",
"jobstatus": integer,
"revoked": boolean
}
}NICs
addNicToVirtualMachine
Voeg netwerkinterface toe.
Parameters:
virtualmachineid(string)networkid(string)- Response Type:
json
{
"addnictovirtualmachineresponse": {
"id": "uuid (string)",
"nicid": "uuid (string)",
"networkid": "uuid (string)",
"netmask": "string",
"gateway": "string",
"ipaddress": "string",
"traffictype": "string",
"isdefault": boolean,
"broadcasturi": "string",
"type": "string",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"project": "string",
"projectid": "uuid (string)"
}
}removeNicFromVirtualMachine
Verwijder netwerkinterface.
Parameters:
nicid(string)- Response Type:
json
{
"removenicfromvirtualmachineresponse": {
"id": "uuid (string)",
"nicid": "uuid (string)",
"networkid": "uuid (string)",
"netmask": "string",
"gateway": "string",
"ipaddress": "string",
"traffictype": "string",
"isdefault": boolean,
"broadcasturi": "string",
"type": "string",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"project": "string",
"projectid": "uuid (string)",
"removed": boolean
}
}updateVmNicIp
Wijzig IP van NIC.
Parameters:
nicid(string)ipaddress(string)- Response Type:
json
{
"updatevmnicipresponse": {
"id": "uuid (string)",
"nicid": "uuid (string)",
"networkid": "uuid (string)",
"netmask": "string",
"gateway": "string",
"ipaddress": "string",
"traffictype": "string",
"isdefault": boolean,
"broadcasturi": "string",
"type": "string",
"virtualmachineid": "uuid (string)",
"virtualmachinename": "string",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"zoneid": "uuid (string)",
"zonename": "string",
"project": "string",
"projectid": "uuid (string)"
}
}listNics
Lijst NICs van VM.
Parameters:
virtualmachineid(string)- Response Type: { "listnicsresponse": { "count": integer, "nic": [ { "id": "uuid (string)", "networkid": "uuid (string)", "netmask": "string", "gateway": "string", "ipaddress": "string", "traffictype": "string", "isdefault": boolean, "broadcasturi": "string", "type": "string", "virtualmachineid": "uuid (string)", "virtualmachinename": "string", "account": "string", "domainid": "uuid (string)", "domain": "string", "zoneid": "uuid (string)", "zonename": "string", "project": "string", "projectid": "uuid (string)" } ] } }
Load Balancers
createLoadBalancerRule
Maak load balancer.
Parameters:
name(string)algorithm(string)privateport(integer)publicport(integer)ipaddressid(string)- Response Type:
json
{
"createloadbalancerruleresponse": {
"id": "uuid (string)",
"name": "string",
"description": "string",
"algorithm": "string",
"privateport": integer,
"publicport": integer,
"publicipid": "uuid (string)",
"publicip": "string",
"networkid": "uuid (string)",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"state": "string",
"jobid": "uuid (string)",
"jobstatus": integer,
"zoneid": "uuid (string)",
"zonename": "string"
}
}assignToLoadBalancerRule
Voeg VM's toe aan LB.
Parameters:
id(string)virtualmachineids(string, komma-gescheiden)- Response Type:
json
{
"assigntoloadbalancerruleresponse": {
"id": "uuid (string)",
"name": "string",
"description": "string",
"algorithm": "string",
"privateport": integer,
"publicport": integer,
"publicipid": "uuid (string)",
"publicip": "string",
"networkid": "uuid (string)",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"state": "string",
"jobid": "uuid (string)",
"jobstatus": integer,
"zoneid": "uuid (string)",
"zonename": "string",
"virtualmachine": [
{
"id": "uuid (string)",
"name": "string",
"ipaddress": "string",
"networkid": "uuid (string)"
}
]
}
}removeFromLoadBalancerRule
Verwijder VM's van LB.
Parameters:
id(string)virtualmachineids(string, komma-gescheiden)- Response Type:
json
{
"removefromloadbalancerruleresponse": {
"id": "uuid (string)",
"name": "string",
"description": "string",
"algorithm": "string",
"privateport": integer,
"publicport": integer,
"publicipid": "uuid (string)",
"publicip": "string",
"networkid": "uuid (string)",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"state": "string",
"jobid": "uuid (string)",
"jobstatus": integer,
"zoneid": "uuid (string)",
"zonename": "string",
"virtualmachine": [
{
"id": "uuid (string)",
"name": "string",
"ipaddress": "string",
"networkid": "uuid (string)"
}
]
}
}listLoadBalancerRules
Lijst load balancer regels.
Parameters:
account(string, optioneel)networkid(string, optioneel)- Response Type:
json
{
"listloadbalancerrulesresponse": {
"count": integer,
"loadbalancerrule": [
{
"id": "uuid (string)",
"name": "string",
"description": "string",
"algorithm": "string",
"privateport": integer,
"publicport": integer,
"publicipid": "uuid (string)",
"publicip": "string",
"networkid": "uuid (string)",
"account": "string",
"domainid": "uuid (string)",
"domain": "string",
"project": "string",
"projectid": "uuid (string)",
"state": "string",
"jobid": "uuid (string)",
"jobstatus": integer,
"zoneid": "uuid (string)",
"zonename": "string",
"virtualmachine": [
{
"id": "uuid (string)",
"name": "string",
"ipaddress": "string",
"networkid": "uuid (string)"
}
]
}
]
}
}Gebruikers & Accounts
listUsers
Lijst gebruikers.
Parameters:
id(string, optioneel)username(string, optioneel)- Response Type:
json
{
"listusersresponse": {
"count": integer,
"user": [
{
"id": "uuid (string)",
"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"account": "string",
"accounttype": integer,
"domainid": "uuid (string)",
"domain": "string",
"timezone": "string",
"state": "string",
"apikey": "string",
"secretkey": "string"
}
]
}
}createUser
Maak gebruiker aan.
Parameters:
username(string)password(string)email(string)firstname(string)lastname(string)account(string)domainid(string)accounttype(integer)- Response Type:
json
{
"createuserresponse": {
"id": "uuid (string)",
"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"account": "string",
"accounttype": integer,
"domainid": "uuid (string)",
"domain": "string",
"timezone": "string",
"state": "string",
"apikey": "string",
"secretkey": "string"
}
}updateUser
Wijzig gebruiker.
Parameters:
id(string)username(string, optioneel)password(string, optioneel)email(string, optioneel)firstname(string, optioneel)lastname(string, optioneel)timezone(string, optioneel)state(string, optioneel)account(string, optioneel)domainid(string, optioneel)- Response Type:
json
{
"updateuserresponse": {
"id": "uuid (string)",
"username": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"account": "string",
"accounttype": integer,
"domainid": "uuid (string)",
"domain": "string",
"timezone": "string",
"state": "string",
"apikey": "string",
"secretkey": "string"
}
}