Apache CloudStack v4.6.0 Root Admin API Reference


Lists all available service offerings.

Request parameters

Parameter NameDescriptionRequired
domainidlist only resources belonging to the domain specifiedfalse
idID of the service offeringfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
issystemis this a system vm offeringfalse
keywordList by keywordfalse
listallIf 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 falsefalse
namename of the service offeringfalse
systemvmtypethe system VM type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter".false
virtualmachineidthe 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

Response Tags

Response NameDescription
idthe id of the service offering
cpunumberthe number of CPU
cpuspeedthe clock rate CPU speed in Mhz
createdthe date this service offering was created
defaultuseis this a default system vm offering
deploymentplannerdeployment strategy used to deploy VM.
diskBytesReadRatebytes read rate of the service offering
diskBytesWriteRatebytes write rate of the service offering
diskIopsReadRateio requests read rate of the service offering
diskIopsWriteRateio requests write rate of the service offering
displaytextan alternate display text of the service offering.
domainDomain name for the offering
domainidthe domain id of the service offering
hosttagsthe host tag for the service offering
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedis true if the offering is customized
iscustomizediopstrue if disk offering uses custom iops, false otherwise
issystemis this a system vm offering
isvolatiletrue 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
limitcpuuserestrict the CPU usage to committed service offering
maxiopsthe max iops of the disk offering
memorythe memory in MB
miniopsthe min iops of the disk offering
namethe name of the service offering
networkratedata transfer rate in megabits per second allowed.
offerhathe ha support in the service offering
provisioningtypeprovisioning type used to create volumes. Valid values are thin, sparse, fat.
serviceofferingdetailsadditional key/value details tied with this service offering
storagetypethe storage type for this service offering
systemvmtypeis this a the systemvm type for system vm offering
tagsthe tags for the service offering