Apache CloudStack 4.20.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 |
| 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 |
| 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 |
| 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 virtual machines available for this project to acquire |
| vmlimit | the total number of virtual machines that can be deployed by this project |
| vmrunning | the total number of virtual machines running for this project |
| vmstopped | the total number of virtual machines stopped for this project |
| vmtotal | the total number of virtual machines 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 vm |
| 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 |