Apache CloudStack 4.15.0.0 Root Admin API Reference

listDomains

Lists domains and provides detailed information for listed domains

Request parameters

Parameter NameDescriptionRequired
detailscomma separated list of domain details requested, value can be a list of [ all, resource, min]false
idList domain by domain ID.false
keywordList by keywordfalse
levelList domains by domain level.false
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
nameList domain by domain name.false
pagefalse
pagesizefalse

Response Tags

Response NameDescription
idthe ID of the domain
cpuavailablethe total number of cpu cores available to be created for this domain
cpulimitthe total number of cpu cores the domain can own
cputotalthe total number of cpu cores owned by domain
haschildwhether the domain has one or more sub-domains
ipavailablethe total number of public ip addresses available for this domain to acquire
iplimitthe total number of public ip addresses this domain can acquire
iptotalthe total number of public ip addresses allocated for this domain
levelthe level of the domain
memoryavailablethe total memory (in MB) available to be created for this domain
memorylimitthe total memory (in MB) the domain can own
memorytotalthe total memory (in MB) owned by domain
namethe name of the domain
networkavailablethe total number of networks available to be created for this domain
networkdomainthe network domain
networklimitthe total number of networks the domain can own
networktotalthe total number of networks owned by domain
parentdomainidthe domain ID of the parent domain
parentdomainnamethe domain name of the parent domain
paththe path of the domain
primarystorageavailablethe total primary storage space (in GiB) available to be used for this domain
primarystoragelimitthe total primary storage space (in GiB) the domain can own
primarystoragetotalthe total primary storage space (in GiB) owned by domain
projectavailablethe total number of projects available for administration by this domain
projectlimitthe total number of projects the domain can own
projecttotalthe total number of projects being administrated by this domain
secondarystorageavailablethe total secondary storage space (in GiB) available to be used for this domain
secondarystoragelimitthe total secondary storage space (in GiB) the domain can own
secondarystoragetotalthe total secondary storage space (in GiB) owned by domain
snapshotavailablethe total number of snapshots available for this domain
snapshotlimitthe total number of snapshots which can be stored by this domain
snapshottotalthe total number of snapshots stored by this domain
statethe state of the domain
templateavailablethe total number of templates available to be created by this domain
templatelimitthe total number of templates which can be created by this domain
templatetotalthe total number of templates which have been created by this domain
vmavailablethe total number of virtual machines available for this domain to acquire
vmlimitthe total number of virtual machines that can be deployed by this domain
vmtotalthe total number of virtual machines deployed by this domain
volumeavailablethe total volume available for this domain
volumelimitthe total volume which can be used by this domain
volumetotalthe total volume being used by this domain
vpcavailablethe total number of vpcs available to be created for this domain
vpclimitthe total number of vpcs the domain can own
vpctotalthe total number of vpcs owned by domain