Apache CloudStack 4.23.0.0 Root Admin API Reference
listProjects
Lists projects and provides detailed information for listed projects
Request parameters
| Parameter Name | Description | Required |
| account | List resources by Account. Must be used with the domainId parameter. | false |
| details | Comma separated list of project details requested, value can be a list of [ all, resource, min] | false |
| displaytext | List projects by display text | false |
| domainid | List only resources belonging to the domain specified | false |
| id | List projects by project ID | false |
| isrecursive | Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| keyword | List by keyword | 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. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| name | List projects by name | false |
| page | false | |
| pagesize | false | |
| showicon | Flag to display the resource icon for projects | false |
| state | List projects by state | false |
| tags | List projects by tags (key/value pairs) | false |
| username | List projects by username | false |
Response Tags
| Response Name | Description |
| id | The ID of the project |
| backupavailable | the total number of backups available to this project |
| backuplimit | the total number of backups which can be stored by this project |
| backupstorageavailable | the total backup storage space (in GiB) available to the project |
| backupstoragelimit | the total backup storage space (in GiB) the project can own |
| backupstoragetotal | the total backup storage space (in GiB) owned by the project |
| backuptotal | the total number of backups stored by this project |
| bucketavailable | the total number of buckets available to this project |
| bucketlimit | the total number of buckets which can be stored by this project |
| buckettotal | the total number of buckets stored by this project |
| cpuavailable | The total number of CPU cores available to be created for this project |
| cpulimit | The total number of CPU cores the project can own |
| cputotal | The total number of CPU cores owned by project |
| created | The date this project was created |
| displaytext | The displaytext of the project |
| domain | The domain name where the project belongs to |
| domainid | The domain ID the project belongs to |
| gpuavailable | the total number of gpus available to be created for this project |
| gpulimit | the total number of gpus the project can own |
| gputotal | the total number of gpus owned by project |
| icon | Base64 string representation of the resource icon |
| ipavailable | The total number of public IP addresses available for this project to acquire |
| iplimit | The total number of public IP addresses this project can acquire |
| iptotal | The total number of public IP addresses allocated for this project |
| memoryavailable | The total memory (in MB) available to be created for this project |
| memorylimit | The total memory (in MB) the project can own |
| memorytotal | The total memory (in MB) owned by project |
| name | The name of the project |
| networkavailable | The total number of Networks available to be created for this project |
| networklimit | The total number of Networks the project can own |
| networktotal | The total number of Networks owned by project |
| objectstorageavailable | the total object storage space (in GiB) available to the project |
| objectstoragelimit | the total object storage space (in GiB) the project can own |
| objectstoragetotal | the total object storage space (in GiB) owned by the project |
| owner | The Account name of the project's owners |
| primarystorageavailable | The total primary storage space (in GiB) available to be used for this project |
| primarystoragelimit | The total primary storage space (in GiB) the project can own |
| primarystoragetotal | The total primary storage space (in GiB) owned by project |
| projectaccountname | The project Account name of the project |
| secondarystorageavailable | The total secondary storage space (in GiB) available to be used for this project |
| secondarystoragelimit | The total secondary storage space (in GiB) the project can own |
| secondarystoragetotal | The total secondary storage space (in GiB) owned by project |
| snapshotavailable | The total number of Snapshots available for this project |
| snapshotlimit | The total number of Snapshots which can be stored by this project |
| snapshottotal | The total number of Snapshots stored by this project |
| state | The state of the project |
| taggedresources | The tagged resource limit and count for the project |
| templateavailable | The total number of Templates available to be created by this project |
| templatelimit | The total number of Templates which can be created by this project |
| templatetotal | The total number of Templates which have been created by this project |
| vmavailable | The total number of Instances available for this project to acquire |
| vmlimit | The total number of Instances that can be deployed by this project |
| vmrunning | The total number of Instances running for this project |
| vmstopped | The total number of Instances stopped for this project |
| vmtotal | The total number of Instances deployed by this project |
| volumeavailable | The total volume available for this project |
| volumelimit | The total volume which can be used by this project |
| volumetotal | The total volume being used by this project |
| vpcavailable | The total number of VPCs available to be created for this project |
| vpclimit | The total number of VPCs the project can own |
| vpctotal | The total number of VPCs owned by project |
| tags(*) | The list of resource tags associated with Instance |
| account | The Account associated with the tag |
| customer | Customer associated with the tag |
| domain | The domain associated with the tag |
| domainid | The ID of the domain associated with the tag |
| domainpath | Path of the Domain associated with the tag |
| key | Tag key name |
| project | The project name where tag belongs to |
| projectid | The project ID the tag belongs to |
| resourceid | ID of the resource |
| resourcetype | Resource type |
| value | Tag value |