Apache CloudStack 4.20.0.0 Root Admin API Reference
listServiceOfferings
Lists all available service offerings.
Request parameters
| Parameter Name | Description | Required |
| account | list resources by account. Must be used with the domainId parameter. | false |
| cpunumber | the CPU number that listed offerings must support | false |
| cpuspeed | the CPU speed that listed offerings must support | false |
| domainid | list only resources belonging to the domain specified | false |
| encryptroot | listed offerings support root disk encryption | false |
| id | ID of the service offering | false |
| isrecursive | defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| issystem | is this a system vm offering | 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 |
| memory | the RAM memory that listed offering must support | false |
| name | name of the service offering | false |
| page | false | |
| pagesize | false | |
| projectid | list objects by project; if projectid=-1 lists All VMs | false |
| state | Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings. | false |
| storagetype | the storage type of the service offering. Values are local and shared. | false |
| systemvmtype | the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter". | false |
| templateid | The ID of the template that listed offerings must support | false |
| virtualmachineid | the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to. | false |
| zoneid | id of zone disk offering is associated with | false |
Response Tags
| Response Name | Description |
| id | the id of the service offering |
| cacheMode | the cache mode to use for this disk offering. none, writeback or writethrough |
| cpunumber | the number of CPU |
| cpuspeed | the clock rate CPU speed in Mhz |
| created | the date this service offering was created |
| defaultuse | is this a default system vm offering |
| deploymentplanner | deployment strategy used to deploy VM. |
| diskBytesReadRate | bytes read rate of the service offering |
| diskBytesReadRateMax | burst bytes read rate of the disk offering |
| diskBytesReadRateMaxLength | length (in seconds) of the burst |
| diskBytesWriteRate | bytes write rate of the service offering |
| diskBytesWriteRateMax | burst bytes write rate of the disk offering |
| diskBytesWriteRateMaxLength | length (in seconds) of the burst |
| diskIopsReadRate | io requests read rate of the service offering |
| diskIopsReadRateMax | burst io requests read rate of the disk offering |
| diskIopsReadRateMaxLength | length (in second) of the burst |
| diskIopsWriteRate | io requests write rate of the service offering |
| diskIopsWriteRateMax | burst io requests write rate of the disk offering |
| diskIopsWriteRateMaxLength | length (in seconds) of the burst |
| diskofferingdisplaytext | the display text of the disk offering |
| diskofferingid | the ID of the disk offering to which service offering is linked |
| diskofferingname | name of the disk offering |
| diskofferingstrictness | True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed |
| displaytext | an alternate display text of the service offering. |
| domain | the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| domainid | the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| dynamicscalingenabled | true if virtual machine needs to be dynamically scalable of cpu or memory |
| encryptroot | true if virtual machine root disk will be encrypted on storage |
| hosttags | the host tag for the service offering |
| hypervisorsnapshotreserve | Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) |
| iscustomized | is true if the offering is customized |
| iscustomizediops | true if disk offering uses custom iops, false otherwise |
| issystem | is this a system vm offering |
| isvolatile | true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk |
| limitcpuuse | restrict the CPU usage to committed service offering |
| maxiops | the max iops of the disk offering |
| memory | the memory in MB |
| miniops | the min iops of the disk offering |
| name | the name of the service offering |
| networkrate | data transfer rate in megabits per second allowed. |
| offerha | the ha support in the service offering |
| provisioningtype | provisioning type used to create volumes. Valid values are thin, sparse, fat. |
| purgeresources | Whether to cleanup VM and its associated resource upon expunge |
| rootdisksize | Root disk size in GB |
| serviceofferingdetails | additional key/value details tied with this service offering |
| state | state of the service offering |
| storagetags | the tags for the service offering |
| storagetype | the storage type for this service offering |
| systemvmtype | is this a the systemvm type for system vm offering |
| vspherestoragepolicy | the vsphere storage policy tagged to the service offering in case of VMware |
| zone | the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |
| zoneid | the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable. |