Apache CloudStack 4.17.0.0 Root Admin API Reference

listDiskOfferings

Lists all available disk offerings.

Request parameters

Parameter NameDescriptionRequired
domainidlist only resources belonging to the domain specifiedfalse
idID of the disk offeringfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
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 false. Resources dedicated to a project are listed only if using the projectid parameter.false
namename of the disk offeringfalse
pagefalse
pagesizefalse
storageidThe ID of the storage pool, tags of the storage pool are used to filter the offeringsfalse
volumeidThe ID of the volume, tags of the volume are used to filter the offeringsfalse
zoneidid of zone disk offering is associated withfalse

Response Tags

Response NameDescription
idunique ID of the disk offering
cacheModethe cache mode to use for this disk offering. none, writeback or writethrough
createdthe date this disk offering was created
diskBytesReadRatebytes read rate of the disk offering
diskBytesReadRateMaxburst bytes read rate of the disk offering
diskBytesReadRateMaxLengthlength (in seconds) of the burst
diskBytesWriteRatebytes write rate of the disk offering
diskBytesWriteRateMaxburst bytes write rate of the disk offering
diskBytesWriteRateMaxLengthlength (in seconds) of the burst
diskIopsReadRateio requests read rate of the disk offering
diskIopsReadRateMaxburst io requests read rate of the disk offering
diskIopsReadRateMaxLengthlength (in second) of the burst
diskIopsWriteRateio requests write rate of the disk offering
diskIopsWriteRateMaxburst io requests write rate of the disk offering
diskIopsWriteRateMaxLengthlength (in seconds) of the burst
disksizethe size of the disk offering in GB
disksizestrictnessTo allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed
displayofferingwhether to display the offering to the end user or not.
displaytextan alternate display text of the disk offering.
domainthe domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidthe domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
iscustomizedtrue if disk offering uses custom size, false otherwise
iscustomizediopstrue if disk offering uses custom iops, false otherwise
maxiopsthe max iops of the disk offering
miniopsthe min iops of the disk offering
namethe name of the disk offering
provisioningtypeprovisioning type used to create volumes. Valid values are thin, sparse, fat.
storagetypethe storage type for this disk offering
tagsthe tags for the disk offering
vspherestoragepolicythe vsphere storage policy tagged to the disk offering in case of VMware
zonethe zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
zoneidthe zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.