Cosmic Admin API Reference

createDiskOffering

Creates a disk offering.

Request parameters

Parameter NameDescriptionRequired
displaytextalternate display text of the disk offeringtrue
namename of the disk offeringtrue
bytesreadratebytes read rate of the disk offeringfalse
byteswriteratebytes write rate of the disk offeringfalse
customizedwhether disk offering size is custom or notfalse
customizediopswhether disk offering iops is custom or notfalse
disksizesize of the disk offering in GB (1GB = 1,073,741,824 bytes)false
displayofferingan optional field, whether to display the offering to the end user or not.false
domainidthe ID of the containing domain, null for public offeringsfalse
hypervisorsnapshotreserveHypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen)false
iopsratepergbio requests per GBfalse
iopsreadrateio requests read rate of the disk offeringfalse
iopstotalrateio requests generic total rate of the disk offeringfalse
iopswriterateio requests write rate of the disk offeringfalse
maxiopsmax iops of the disk offeringfalse
miniopsmin iops of the disk offeringfalse
provisioningtypeprovisioning type used to create volumes. Valid values are thin, sparse, fat.false
storagetypethe storage type of the disk offering. Values are local and shared.false
tagstags for the disk offeringfalse

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
diskBytesWriteRatebytes write rate of the disk offering
diskIopsRatePerGbio requests per GB
diskIopsReadRateio requests read rate of the disk offering
diskIopsTotalRateio requests total rate of the disk offering
diskIopsWriteRateio requests write rate of the disk offering
disksizethe size of the disk offering in GB
displayofferingwhether to display the offering to the end user or not.
displaytextan alternate display text of the disk offering.
domainthe domain name this disk offering belongs to. Ignore this information as it is not currently applicable.
domainidthe domain ID 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)
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