Apache CloudStack 4.20.0.0 Root Admin API Reference
listDomains
Lists domains and provides detailed information for listed domains
Request parameters
| Parameter Name | Description | Required |
| details | comma separated list of domain details requested, value can be a list of [ all, resource, min] | false |
| id | List domain by domain ID. | false |
| keyword | List by keyword | false |
| level | List domains by domain level. | false |
| listall | If 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 false | false |
| name | List domain by domain name. | false |
| page | false | |
| pagesize | false | |
| showicon | flag to display the resource icon for domains | false |
| tag | Tag for resource type to return usage | false |
Response Tags
| Response Name | Description |
| id | the ID of the domain |
| cpuavailable | the total number of cpu cores available to be created for this domain |
| cpulimit | the total number of cpu cores the domain can own |
| cputotal | the total number of cpu cores owned by domain |
| created | the date when this domain was created |
| domaindetails | details for the domain |
| haschild | whether the domain has one or more sub-domains |
| icon | Base64 string representation of the resource icon |
| ipavailable | the total number of public ip addresses available for this domain to acquire |
| iplimit | the total number of public ip addresses this domain can acquire |
| iptotal | the total number of public ip addresses allocated for this domain |
| level | the level of the domain |
| memoryavailable | the total memory (in MB) available to be created for this domain |
| memorylimit | the total memory (in MB) the domain can own |
| memorytotal | the total memory (in MB) owned by domain |
| name | the name of the domain |
| networkavailable | the total number of networks available to be created for this domain |
| networkdomain | the network domain |
| networklimit | the total number of networks the domain can own |
| networktotal | the total number of networks owned by domain |
| parentdomainid | the domain ID of the parent domain |
| parentdomainname | the domain name of the parent domain |
| path | the path of the domain |
| primarystorageavailable | the total primary storage space (in GiB) available to be used for this domain |
| primarystoragelimit | the total primary storage space (in GiB) the domain can own |
| primarystoragetotal | the total primary storage space (in GiB) owned by domain |
| projectavailable | the total number of projects available for administration by this domain |
| projectlimit | the total number of projects the domain can own |
| projecttotal | the total number of projects being administrated by this domain |
| secondarystorageavailable | the total secondary storage space (in GiB) available to be used for this domain |
| secondarystoragelimit | the total secondary storage space (in GiB) the domain can own |
| secondarystoragetotal | the total secondary storage space (in GiB) owned by domain |
| snapshotavailable | the total number of snapshots available for this domain |
| snapshotlimit | the total number of snapshots which can be stored by this domain |
| snapshottotal | the total number of snapshots stored by this domain |
| state | the state of the domain |
| taggedresources | The tagged resource limit and count for the domain |
| templateavailable | the total number of templates available to be created by this domain |
| templatelimit | the total number of templates which can be created by this domain |
| templatetotal | the total number of templates which have been created by this domain |
| vmavailable | the total number of virtual machines available for this domain to acquire |
| vmlimit | the total number of virtual machines that can be deployed by this domain |
| vmtotal | the total number of virtual machines deployed by this domain |
| volumeavailable | the total volume available for this domain |
| volumelimit | the total volume which can be used by this domain |
| volumetotal | the total volume being used by this domain |
| vpcavailable | the total number of vpcs available to be created for this domain |
| vpclimit | the total number of vpcs the domain can own |
| vpctotal | the total number of vpcs owned by domain |