listAccounts

Lists accounts and provides detailed account information for listed accounts #

Request Parameters

Parameter Name Description Required
accounttype list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user). false
domainid list all accounts in specified domain. If used with the name parameter, retrieves account information for the account with specified name in specified domain. false
id list account by account ID false
iscleanuprequired list accounts by cleanuprequred attribute (values are true or false) false
isrecursive defaults to false, but if true, lists all accounts from the parent specified by the domain id till leaves. false
keyword List by keyword false
name list account by account name false
page false
pagesize false
state list accounts by state. Valid states are enabled, disabled, and locked. false

Response Tags

Response Name Description
id the id of the account
accounttype account type (admin, domain-admin, user)
domain name of the Domain the account belongs too
domainid id of the Domain the account belongs too
ipavailable the total number of public ip addresses available for this account to acquire
iplimit the total number of public ip addresses this account can acquire
iptotal the total number of public ip addresses allocated for this account
iscleanuprequired true if the account requires cleanup
name the name of the account
networkdomain the network domain
receivedbytes the total number of network traffic bytes received
sentbytes the total number of network traffic bytes sent
snapshotavailable the total number of snapshots available for this account
snapshotlimit the total number of snapshots which can be stored by this account
snapshottotal the total number of snapshots stored by this account
state the state of the account
templateavailable the total number of templates available to be created by this account
templatelimit the total number of templates which can be created by this account
templatetotal the total number of templates which have been created by this account
vmavailable the total number of virtual machines available for this account to acquire
vmlimit the total number of virtual machines that can be deployed by this account
vmrunning the total number of virtual machines running for this account
vmstopped the total number of virtual machines stopped for this account
vmtotal the total number of virtual machines deployed by this account
volumeavailable the total volume available for this account
volumelimit the total volume which can be used by this account
volumetotal the total volume being used by this account
user(*) the list of users associated with account
id the user ID
account the account name of the user
accounttype the account type of the user
apikey the api key of the user
created the date and time the user account was created
domain the domain name of the user
domainid the domain ID of the user
email the user email address
firstname the user firstname
lastname the user lastname
secretkey the secret key of the user
state the user state
timezone the timezone user was created in
username the user name
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, 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, listVolumes, createVolume, attachVolume, detachVolume, deleteVolume, listNetworkOfferings, createNetwork, deleteNetwork, listTags, createTags, deleteTags