Apache CloudStack 4.15.0.0 Root Admin API Reference
listServiceOfferings
Lists all available service offerings.
Request parameters
| Parameter Name | Description | Required |
| 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 |
| 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 | false |
| memory | the RAM memory that listed offering must support | false |
| name | name of the service offering | false |
| page | false | |
| pagesize | false | |
| systemvmtype | the system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter". | 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 |
| 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. |
| 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. |
| rootdisksize | Root disk size in GB |
| serviceofferingdetails | additional key/value details tied with this service offering |
| storagetype | the storage type for this service offering |
| systemvmtype | is this a the systemvm type for system vm offering |
| tags | the tags for the service 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. |