listVolumes

Lists all volumes.

Request Parameters

Parameter Name Description Required
account the account associated with the disk volume. Must be used with the domainId parameter. false
domainid Lists all disk volumes for the specified domain ID. If used with the account parameter, returns all disk volumes for an account in the specified domain ID. false
hostid list volumes on specified host false
id the ID of the disk volume false
isrecursive defaults to false, but if true, lists all volumes from the parent specified by the domain id till leaves. false
keyword List by keyword false
name the name of the disk volume false
page false
pagesize false
podid the pod id the disk volume belongs to false
type the type of disk volume false
virtualmachineid the ID of the virtual machine false
zoneid the ID of the availability zone false

Response Tags

Response Name Description
id ID of the disk volume
account the account associated with the disk volume
attached the date the volume was attached to a VM instance
created the date the disk volume was created
destroyed the boolean state of whether the volume is destroyed or not
deviceid the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskofferingdisplaytext the display text of the disk offering
diskofferingid ID of the disk offering
diskofferingname name of the disk offering
domain the domain associated with the disk volume
domainid the ID of the domain associated with the disk volume
hypervisor Hypervisor the volume belongs to
isextractable true if the volume is extractable, false otherwise
jobid shows the current pending asynchronous job ID. This tag is not returned if no current pending jobs are acting on the volume
jobstatus shows the current pending asynchronous job status
name name of the disk volume
serviceofferingdisplaytext the display text of the service offering for root disk
serviceofferingid ID of the service offering for root disk
serviceofferingname name of the service offering for root disk
size size of the disk volume
snapshotid ID of the snapshot from which this volume was created
state the state of the disk volume
storage name of the primary storage hosting the disk volume
storagetype shared or local storage
type type of the disk volume (ROOT or DATADISK)
virtualmachineid id of the virtual machine
vmdisplayname display name of the virtual machine
vmname name of the virtual machine
vmstate state of the virtual machine
zoneid ID of the availability zone
zonename name of the availability zone
Related Pages: listNetworks, restartNetwork, updateNetwork, associateIpAddress, disassociateIpAddress, listPublicIpAddresses, createLoadBalancerRule, deleteLoadBalancerRule, removeFromLoadBalancerRule, assignToLoadBalancerRule, listLoadBalancerRules, listLoadBalancerRuleInstances, updateLoadBalancerRule, listPortForwardingRules, createPortForwardingRule, deletePortForwardingRule, createFirewallRule, deleteFirewallRule, listFirewallRules, createRemoteAccessVpn, deleteRemoteAccessVpn, listRemoteAccessVpns, enableStaticNat, createIpForwardingRule, deleteIpForwardingRule, listIpForwardingRules, disableStaticNat, extractVolume, listZones, login, logout, listAccounts, queryAsyncJobResult, listAsyncJobs, listServiceOfferings, listDiskOfferings, registerSSHKeyPair, createSSHKeyPair, deleteSSHKeyPair, listSSHKeyPairs, listVirtualMachines, destroyVirtualMachine, rebootVirtualMachine, stopVirtualMachine, resetPasswordForVirtualMachine, changeServiceForVirtualMachine, updateVirtualMachine, getVMPassword, deployVirtualMachine, startVirtualMachine, listSnapshots, listSnapshotPolicies, deleteSnapshot, createSnapshot, createSnapshotPolicy, deleteSnapshotPolicies, listTemplates, createTemplate, registerTemplate, updateTemplate, copyTemplate, deleteTemplate, updateTemplatePermissions, listTemplatePermissions, extractTemplate, listSecurityGroups, createSecurityGroup, deleteSecurityGroup, authorizeSecurityGroupIngress, revokeSecurityGroupIngress, createVolume, attachVolume, detachVolume, deleteVolume, listNetworkOfferings, createNetwork, deleteNetwork, listTags, createTags, deleteTags