Apache CloudStack 4.14.1.0-SNAPSHOT Root Admin API Reference
createDiskOffering
Creates a disk offering.
Request parameters
Parameter Name | Description | Required |
displaytext | alternate display text of the disk offering | true |
name | name of the disk offering | true |
bytesreadrate | bytes read rate of the disk offering | false |
bytesreadratemax | burst bytes read rate of the disk offering | false |
bytesreadratemaxlength | length (in seconds) of the burst | false |
byteswriterate | bytes write rate of the disk offering | false |
byteswriteratemax | burst bytes write rate of the disk offering | false |
byteswriteratemaxlength | length (in seconds) of the burst | false |
cachemode | the cache mode to use for this disk offering. none, writeback or writethrough | false |
customized | whether disk offering size is custom or not | false |
customizediops | whether disk offering iops is custom or not | false |
disksize | size of the disk offering in GB (1GB = 1,073,741,824 bytes) | false |
displayoffering | an optional field, whether to display the offering to the end user or not. | false |
domainid | the ID of the containing domain(s), null for public offerings | false |
hypervisorsnapshotreserve | Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) | false |
iopsreadrate | io requests read rate of the disk offering | false |
iopsreadratemax | burst requests read rate of the disk offering | false |
iopsreadratemaxlength | length (in seconds) of the burst | false |
iopswriterate | io requests write rate of the disk offering | false |
iopswriteratemax | burst io requests write rate of the disk offering | false |
iopswriteratemaxlength | length (in seconds) of the burst | false |
maxiops | max iops of the disk offering | false |
miniops | min iops of the disk offering | false |
provisioningtype | provisioning type used to create volumes. Valid values are thin, sparse, fat. | false |
storagetype | the storage type of the disk offering. Values are local and shared. | false |
tags | tags for the disk offering | false |
zoneid | the ID of the containing zone(s), null for public offerings | false |
Response Tags
Response Name | Description |
id | unique ID of the disk offering |
cacheMode | the cache mode to use for this disk offering. none, writeback or writethrough |
created | the date this disk offering was created |
diskBytesReadRate | bytes read rate of the disk offering |
diskBytesReadRateMax | burst bytes read rate of the disk offering |
diskBytesReadRateMaxLength | length (in seconds) of the burst |
diskBytesWriteRate | bytes write rate of the disk offering |
diskBytesWriteRateMax | burst bytes write rate of the disk offering |
diskBytesWriteRateMaxLength | length (in seconds) of the burst |
diskIopsReadRate | io requests read rate of the disk 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 disk offering |
diskIopsWriteRateMax | burst io requests write rate of the disk offering |
diskIopsWriteRateMaxLength | length (in seconds) of the burst |
disksize | the size of the disk offering in GB |
displayoffering | whether to display the offering to the end user or not. |
displaytext | an alternate display text of the disk 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. |
hypervisorsnapshotreserve | Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware) |
iscustomized | true if disk offering uses custom size, false otherwise |
iscustomizediops | true if disk offering uses custom iops, false otherwise |
maxiops | the max iops of the disk offering |
miniops | the min iops of the disk offering |
name | the name of the disk offering |
provisioningtype | provisioning type used to create volumes. Valid values are thin, sparse, fat. |
storagetype | the storage type for this disk offering |
tags | the tags for the disk offering |
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. |